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

Restructure documentation #581

Open
schroedk opened this issue May 13, 2024 · 1 comment · May be fixed by #607
Open

Restructure documentation #581

schroedk opened this issue May 13, 2024 · 1 comment · May be fixed by #607
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@schroedk
Copy link
Collaborator

schroedk commented May 13, 2024

Restructure the documentation into the top-level:

  • getting started:

    • Installation: basics, extras, links to tutorials, links to method explanation
  • tutorials:

    • detecting corrupted labels: synthetic influence, CNN (malaria example?)
    • outlier analysis: wine
    • assigning value to data provider:
    • data pruning:
    • data selection:
  • how-to guides:

    • scaling computation
    • how to speed up computation with parallelization
    • how to speed up computation with caching
    • basic setup of valuation objects
    • basic setup of influence objects
    • choosing and configure samplers
    • choosing sample sizes and stopping criteria
    • advanced configuration of influence computation
    • how to ensure reproducibility
  • methods:

    • valuation
    • influences
  • api:

    • user api
    • development

Take inspiration from

Convention:

  • do not add math formulas to docstrings, but reference the documentation, explain the implication of parameter choices in docstring
  • keep the docstrings as lean as possible and reference the documentation whenever possible
  • tutorials should be motivated by tasks

Wish list:

  • short summary to check if user is on the correct documentation page
  • list of related topics at the beginning of every documentation page
@schroedk schroedk added documentation Improvements or additions to documentation enhancement New feature or request labels May 13, 2024
@schroedk schroedk modified the milestones: v0.11.0, v0.10.0 May 13, 2024
@AnesBenmerzoug
Copy link
Collaborator

As another suggestion, we should write the how-to guides and tutorials as notebooks and execute them, when possible, in CI with caching (with jupyter-cache?) in order to make sure they always run successfully. We should also consider putting directly in the corresponding subdirectory of the docs directory to avoid having to copy them every time.

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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants