fix docstring by removing ResNet

[mohrez86]

The PR fixes the documentation bug discussed in issue #5209.

I tried to follow the instructions in the file CONTRIBUTING.md.

The tool ufmt makes several changes in several modules. So, I did not include the changes in this PR. I can add them if it is necessary.

Building the documentation using the command make html results in a runtime error (maybe it is a problem on my side).

However, running make html-noplot finishes with no error.

[facebook-github-bot]

Hi @mohrez86!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[facebook-github-bot]

💊 CI failures summary and remediations

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

---

• 2/3 failures introduced in this PR
• 1/3 broken upstream at merge base afda28a since Jan 14

---

🕵️ 1 new failure recognized by patterns

The following CI failures do not appear to be due to upstream breakages:

binary_macos_conda_py3.7_cpu (1/1)

Step: "curl -o conda.sh https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh
sh conda.sh -b
source $HOME/miniconda3/bin/activate
conda install -yq conda-build
packaging/build_conda.sh
" (full log | diagnosis details | 🔁 rerun)

HTTP errors are often intermittent, and a simple retry will get you on your way.

    cmd(state, arg)
  File "/Users/distiller/miniconda3/lib/python3.9/site-packages/conda/instructions.py", line 67, in PROGRESSIVEFETCHEXTRACT_CMD
    progressive_fetch_extract.execute()
  File "/Users/distiller/miniconda3/lib/python3.9/site-packages/conda/core/package_cache_data.py", line 655, in execute
    raise CondaMultiError(exceptions)
conda.CondaMultiError: HTTP 502 BAD GATEWAY for url <https://repo.anaconda.com/pkgs/main/osx-64/giflib-5.2.1-haf1e3a3_0.conda>
Elapsed: 00:00.076012
CF-RAY: 6d0aa7a39f05fdc9-ORD

An HTTP error occurred when trying to retrieve this URL.
HTTP errors are often intermittent, and a simple retry will get you on your way.




Exited with code exit status 1

---

1 failure not recognized by patterns:

Job	Step	Action
unittest_windows_gpu_py3.8	Run tests	🔁 rerun

---

🚧 1 ongoing upstream failure:

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

• unittest_prototype since Jan 14 (adf8466)
  • 🔁 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.

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[datumbox]

@NicolasHug @jdsgomes Tagging you to see the feedback of @mohrez86 who is a first-time contributor. He faced a few problems which are worth addressing on the future. I believe the issues he describes with make html are linked to the optional dependencies which actually cause issues if missing while building the documentation. Let me know your thoughts and whether we have any existing issues for fixing this. Thanks!

[datumbox]

@mohrez86 The changes LGTM, thanks a lot! Sorry for the hiccups with our documentation. We will focus on improving this in H1. Hope you will stick around and contribute more on the project.