-
Notifications
You must be signed in to change notification settings - Fork 196
Closed
Labels
Milestone
Description
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 usingruff
), not sure about whatdeepdiff
is used for (could not find any reference to it), maybe removetwine
(only useful to push packages topypi
, 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
anddoc
? this avoids installing a lot a stuff in CI when not needed, and make it clear what each optional deps is used for.
- clean unused dependencies:
-
CI:
- Run
pyright
in a separate step. This makes reporting in the PR easier to read as failure ofTest
only results frompytest
failures. - Split the pre-commit runs into separate steps for the same reason (better reporting and redirecting the user directly to the right error).
- Run
-
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.