Skip to content

Conversation

yassineAlouini
Copy link
Contributor

@yassineAlouini yassineAlouini commented Apr 21, 2022

In this PR, I add the EfficientNet documentation following the guidelines outlined here.

By the way, I thought about being clever with the docstrings (since they repeat between the different) but then refrained from being clever (better explicit than implicit etc). Here is the code I had in mind nonetheless:

efficientnet_b0.__doc__ = EFFICIENTNET_DOCSTRING.format(submodel="bo")

Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

Thanks @yassineAlouini , minor comment but this looks great!

By the way, I thought about being clever with the docstrings

I started with a similar idea as well, but because this makes us document the model builders in slightly unconventional ways (the docstring wouldn't be right below the thing it's documenting), we decided against it, at least for now

@yassineAlouini
Copy link
Contributor Author

Thanks @yassineAlouini , minor comment but this looks great!

By the way, I thought about being clever with the docstrings

I started with a similar idea as well, but because this makes us document the model builders in slightly unconventional ways (the docstring wouldn't be right below the thing it's documenting), we decided against it, at least for now

Awesome, I will fix these small details this afternoon and start the EfficientNet v2 one. 👌

Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

Thanks @yassineAlouini , LGTM!

@yassineAlouini
Copy link
Contributor Author

Thanks @NicolasHug.

facebook-github-bot pushed a commit that referenced this pull request May 6, 2022
Summary:
* [DOC] Add new EfficientNet doc.

* [DOC] Add missing file.

* [FIX] Precommits fix.

* [FIX] Precommits fix.

* [ENH] Integrate few documentation comments from code review

* Update docs/source/models/efficientnet.rst

Reviewed By: jdsgomes, NicolasHug

Differential Revision: D36095667

fbshipit-source-id: 5f14099067480da795edb7418d7a4e2232e8c300

Co-authored-by: Nicolas Hug <contact@nicolas-hug.com>
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.

3 participants