Updates to the documentation - Maxim #2869
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
a99962b to
7431b2d
Compare
13a1b7a to
c7f35c4
Compare
c7f35c4 to
edadf52
Compare
edadf52 to
db687bf
Compare
MMathisLab
added a commit
that referenced
this pull request
Feb 28, 2025
* Updates to the documentation - Maxim (#2869) * Updates to the docs (#2871) * add more docs in single animal userguide * unify train_network docs * unify train_network docs * improved augmentation code * remove link to 3mice TF Colab on homepage * Update readme and conda env * Update readme * docs/pytorch/user_guide Installation: point to docs/installation * Standardize subtitiles accross single and multi user guides * Add missing docstring * improved installation docs * added quick commands * improved docs * install torch and torchvision with pip in the DeepLabCut Conda file * updated labelling in userguides * Update DEEPLABCUT.yaml * install deeplabcut through the pre-release --------- Co-authored-by: Niels <45132115+n-poulsen@users.noreply.github.com> Co-authored-by: Niels Poulsen <niels.poulsen@epfl.ch> Co-authored-by: Mackenzie Mathis <mathis@rowland.harvard.edu>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of the updates to the documentation.
The docs_merge branch is an intermediate branch to cross-review changes before opening a PR into pytorch_dlc.
In particular, I review the following doc files:
Moreover, I copy the fix to build jupyter books locally from niels/docs. This is a temporary commit, it will be picked from niels/docs when combining the changes.
Also, I add additional reference points to docs reviewed in niels/docs to reference here, this will need to be merged.
Also, I introduce a temporary fix to
create_pretrained_project()by forcing it to create fake metadata with TensorFlow as backend engine. This will need to be fixed once Pytorch compatibility is added tocreate_pretrained_project().I also remove docs/recipes/MegaDetectorDLCLive.md from _toc.yml, since the MegaDetector app is not online anymore.
Finally, I update the .rst files to point to the right methods for correct doctring insertion.