Skip to content

Expand README with usage examples and project documentation #28

Closed

Description

@williambdean

The README is currently a single line with no installation instructions, usage examples, or documentation links. This means the PyPI page shows "no project description" despite the README existing.

See PR #27 which fixes the metadata plumbing (readme = "README.md"), but the content itself still needs to be written.

This is related to #4 (example gallery) — once examples exist, the README should link to them. At minimum the README should include:

  • What the library does and how it relates to PyTensor/PyMC
  • Installation instructions
  • A minimal working example (build and train a simple model)
  • Links to relevant resources (docs, examples, PyTensor, PyMC)

Activity

  1. jessegrabowski commented on May 21, 2026

    @jessegrabowski
    Member

    fully on-board with this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions