Skip to content

Change order of sections in toctree #5195

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

Merged
merged 2 commits into from
Jan 18, 2022
Merged

Conversation

NicolasHug
Copy link
Member

@NicolasHug NicolasHug commented Jan 14, 2022

This PR changes the order of our main sections in our docs (transforms, models, datasets...). The new proposed order follows the measured popularity of each page as measured by Google analytics.

@facebook-github-bot
Copy link

facebook-github-bot commented Jan 14, 2022

💊 CI failures summary and remediations

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


None of the CI failures appear to be your fault 💚



🚧 1 ongoing upstream failure:

These were probably caused by upstream breakages that are not fixed yet.


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.

Copy link
Contributor

@prabhat00155 prabhat00155 left a comment

Choose a reason for hiding this comment

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

Thanks @NicolasHug! Just out of curiosity, do we plan on changing this every time there is change in popularity order?

@NicolasHug
Copy link
Member Author

NicolasHug commented Jan 14, 2022

Thanks for the review @prabhat00155 .

I wouldn't think so, as I doubt the relative page usage would drastically change anytime soon. What prompted me to update the order is that there is a significant difference between the dataset page hit vs models and transforms (I can't share numbers publicly but you have them in our workplace chat :) ), so I thought it would make sense not to have the datasets as the first section.

For a few % difference I wouldn't bother though.

ops
io
utils
feature_extraction
Copy link
Contributor

@oke-aditya oke-aditya Jan 15, 2022

Choose a reason for hiding this comment

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

Not clubbing with models? Potentially this is very new feature (and hence low popularity), but the docs are best read after reading models. Anyways, either is fine.

Copy link
Member Author

Choose a reason for hiding this comment

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

We'll likely merge it into the models page once we get to the more general revamp of the models page

@oke-aditya
Copy link
Contributor

The order is very surprising. Surprised by the fact that transforms and models are used more than datasets and utils more than io or ops!
Btw out of curiosity how did you know the popularity %s ? Is this through the torch logging or something internal fb?

@NicolasHug
Copy link
Member Author

@oke-aditya I updated my comment above: we measure the popularity of each page with Google Analytics.

This doesn't necessarily reflect which classes/functions are the most used in practice in users code (this is not something we track), but it tells us exactly which pages are more popular than others, and so it gives us some insight on what doc readers are looking for. In this case, the datasets page is significantly less popular than the transforms and models pages.

@NicolasHug NicolasHug merged commit bf073e7 into pytorch:main Jan 18, 2022
facebook-github-bot pushed a commit that referenced this pull request Jan 19, 2022
Reviewed By: datumbox, NicolasHug

Differential Revision: D33655254

fbshipit-source-id: c409aedab4d25ffbade2dff93410970c35e118be
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.

4 participants