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

docs: SysVI docs #3204

Merged
merged 3 commits into from
Feb 25, 2025
Merged

docs: SysVI docs #3204

merged 3 commits into from
Feb 25, 2025

Conversation

ori-kron-wis
Copy link
Collaborator

@ori-kron-wis ori-kron-wis commented Feb 24, 2025

@Hrovatin feel free to add a model description to /Users/orikr/PycharmProjects/scvi-tools/docs/user_guide/models/sysvi.md, in this PR

@ori-kron-wis ori-kron-wis added the on-merge: backport to 1.2.x on-merge: backport to 1.2.x label Feb 24, 2025
@ori-kron-wis ori-kron-wis self-assigned this Feb 24, 2025
Copy link

codecov bot commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.62%. Comparing base (a6eb7f6) to head (1fd7622).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3204   +/-   ##
=======================================
  Coverage   82.62%   82.62%           
=======================================
  Files         190      190           
  Lines       16556    16556           
=======================================
  Hits        13680    13680           
  Misses       2876     2876           

@Hrovatin
Copy link

Hrovatin commented Feb 24, 2025

@ori-kron-wis thank you very much.
I see many of the other models have small tutorials in the md file and a lot of additional theory behind it. What would be your general guide on how much info we should add here, especially since we have a detailed tutorial in notebook.

@ori-kron-wis
Copy link
Collaborator Author

@Hrovatin , well, it's up to you.
While the tutorial aim is to show an end-to-end typical use case of your model, the model description aim is to have a more theoretical background on it (see some other example, usually we expect to see advantages & limitations of model , the generative and inference processes scheme and tasks it can perform).
I can see your tutorial has some theoretical parts, it's fine, they can have some overlap between them.

As I said, it's up to you, we do have other external models with no theoretical background in RTD, which is a bit pitty, as it reduces the chances of users to really adopting the model.

@ori-kron-wis ori-kron-wis added on-merge: backport to 1.3.x on-merge: backport to 1.3.x and removed on-merge: backport to 1.2.x on-merge: backport to 1.2.x labels Feb 25, 2025
@ori-kron-wis ori-kron-wis merged commit 18ab999 into main Feb 25, 2025
14 of 15 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/scvi-tools that referenced this pull request Feb 25, 2025
ori-kron-wis added a commit that referenced this pull request Feb 25, 2025
Backport PR #3204: docs: SysVI docs

Co-authored-by: Ori Kronfeld <ori.kronfeld@weizmann.ac.il>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
on-merge: backport to 1.3.x on-merge: backport to 1.3.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants