Skip to content

NOMRG Initial draft of models docs revamp #5575

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

Closed
wants to merge 4 commits into from

Conversation

NicolasHug
Copy link
Member

@NicolasHug NicolasHug commented Mar 9, 2022

This is an initial draft of a proposal for revamping the models docs. The basic structure would be:

  • a main Models page with a similar structure to what we have now (classification, detection, optical flow, etc.). This page contains links to:
    • One page per model - i.e. one page for Resnet, one for VGG, etc. Each of these pages contain links to
      • one page per model builder. The model builders would document the possible Weights that can be passed as parameter. The way this would be done is TBD.

@facebook-github-bot
Copy link

facebook-github-bot commented Mar 9, 2022

💊 CI failures summary and remediations

As of commit e4aa074 (more details on the Dr. CI page):


  • 1/1 failures introduced in this PR

1 failure not recognized by patterns:

Job Step Action
CircleCI lint_python_and_config Lint Python code and config files 🔁 rerun

This comment was automatically generated by Dr. CI (expand for details).

Please report bugs/suggestions to the (internal) Dr. CI Users group.

Click here to manually regenerate this comment.

Comment on lines +3 to +4
Prototype Models
################
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the porting from prototype to main is done, this will just become "Models" and the prototype_models.rst file will just become (and overwrite) models.rst

@@ -38,3 +38,4 @@ fi

printf "* Installing torchvision\n"
python setup.py develop
pip install git+https://github.com/pytorch/data.git
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a quick hack, will remove eventually

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants