Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLN improve package maintenability #1008

Closed
11 of 12 tasks
tomMoral opened this issue Mar 18, 2024 · 1 comment · Fixed by #1147
Closed
11 of 12 tasks

CLN improve package maintenability #1008

tomMoral opened this issue Mar 18, 2024 · 1 comment · Fixed by #1147
Labels
documentation Improvements or additions to documentation hackathon

Comments

@tomMoral
Copy link
Contributor

tomMoral commented Mar 18, 2024

A few remarks on improving the package maintainability/doc, let me know if you want me to work on those.

  • Clean up dependencies

    • clean unused dependencies: black, autoflake, flake8, isort (I think you are only using ruff), not sure about what deepdiff is used for (could not find any reference to it), maybe remove twine (only useful to push packages to pypi, not sure it is worth installing for all developers).
    • remove duplicate install in .github/workflows/test.yml (torchtestcase, pytest are installed in [dev])
    • Maybe split dependencies between test and doc? this avoids installing a lot a stuff in CI when not needed, and make it clear what each optional deps is used for.
  • CI:

    • Run pyright in a separate step. This makes reporting in the PR easier to read as failure of Test only results from pytest failures.
    • Split the pre-commit runs into separate steps for the same reason (better reporting and redirecting the user directly to the right error).
  • Doc:

    • Make the documentation generation more straightforward with a single command if possible.
    • Putting clear install instructions (pip install sbi) on the front page would be nice.
    • Make the example of the first page runnable with toy experiment. right now it is hard to know what are the prior, theta, x objects.
    • Put link to tutorials in the first paragraph for discoverability.
    • Move publications to a dedicated page (not sure it is worth being on the front page of the package).
    • Improve API page which is hard to navigate as everything is flatten.
    • autobuild of the doc for the commit, with auto upload when pushing on main? This way the doc is always up to date and you are sure that the doc don't break when merging a PR.
@janfb
Copy link
Contributor

janfb commented Aug 8, 2024

All done in #1147 except the splitting of the pre-commit action, which we decided to not do for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hackathon
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants