[Doc] Indicate necessary context to run multiprocessed collectors in doc

[GJBoth]

This PR updates the docstrings for the MultiSyncCollector and `MultiaSyncCollector. It does several things:

• Add a note that code should be run inside a if __name__ == "__main__": block.
• Updated the examples and fixes some errors, including:
  • The gymenv already has a stepcounter, so removed it.
  • devices and storing_devices kwargs don't exist - it needs to be device and storing_device.
  • Added cat_results="stack" to follow future behaviour.
• The collector wasn't actually imported in the example, so I added that too - it's now self-contained.
• The current main branch also does not pass pre-commit, which is why tensor_specs.py is changed too.

I'm currently building the docs to see if everything looks good, but it's taking very long. Any advice there?

[pytorch-bot]

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/2126

• 📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❌ 4 New Failures, 6 Unrelated Failures

As of commit d425c25 with merge base 3c6b9c6 ():

NEW FAILURES - The following jobs have failed:

• Continuous Benchmark (PR) / CPU Pytest benchmark (gh)
  Workflow failed! Resource not accessible by integration
• Continuous Benchmark (PR) / GPU Pytest benchmark (gh)
  Workflow failed! Resource not accessible by integration
• Habitat Tests on Linux / tests (3.9, 12.1) / linux-job (gh)
  RuntimeError: Command docker exec -t 38bd0b82562a1e749c2af123a5577f446a878c3f0a612618abb6110174838d36 /exec failed with exit code 1
• Lint / python-source-and-configs / linux-job (gh)
  RuntimeError: Command docker exec -t 290cfa4162d34491f17c7c06c85d9da8fb6b8394cdddc4917c6e42e79b52ac19 /exec failed with exit code 1

BROKEN TRUNK - The following jobs failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

• Libs Tests on Linux / unittests-gym (3.9, 12.1) / linux-job (gh)
  test/test_libs.py::TestGym::test_gym_gymnasium_parallel
• Unit-tests on Linux / tests-gpu (3.10, 12.1) / linux-job (gh)
  test/test_env.py::TestAutoReset::test_auto_reset_parallel_hetero
• Unit-tests on Linux / tests-olddeps (3.8, 11.6) / linux-job (gh)
  test/test_rb.py::TestRBMultidim::test_rb_multidim_collector[env_device0-transform1-sampler_cls4-rbtype1-LazyTensorStorage-TensorDictRoundRobinWriter]
• Unit-tests on Linux / tests-optdeps (3.10, 12.1) / linux-job (gh)
  test/test_env.py::TestAutoReset::test_auto_reset_parallel_hetero
• Unit-tests on Linux / tests-stable-gpu (3.10, 11.8) / linux-job (gh)
  test/test_env.py::TestAutoReset::test_auto_reset_parallel_hetero
• Unit-tests on Windows / unittests-cpu / windows-job (gh)
  test/test_collector.py::TestLibThreading::test_auto_num_threads

This comment was automatically generated by Dr. CI and updates every 15 minutes.

[facebook-github-bot]

Hi @GJBoth!

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]

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

[GJBoth]

@vmoens Could you help out here with the failed tests? Some of them failed due to main failing, and I didn't even touch code - just added docs -, so not sure why the CI on benchmarks is failing?

[vmoens]

Yeah those are broken tests on CUDA, I will handle that separately :)

[vmoens]

Thanks! A couple of formatting issues but we should be good to go after that!

[GJBoth]

Just resolved the issues!

[vmoens]

LGTM