Skip to content

Plot torch_sim module graph #132

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.

Sign up for GitHub

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 8 commits into from
Apr 13, 2025
Merged

Plot torch_sim module graph #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a77a504
get_module_graph_dot_file.py script to generate DOT representation of…
janosh Apr 12, 2025
e134c4c
show torch-sim-module-graph.svg in README.md "Core Modules" section
janosh Apr 12, 2025
e886289
fix PR template claiming we use numpy instead of Google doc str format
janosh Apr 12, 2025
f10639a
add URL attributes to nodes linking back to source files on GitHub
janosh Apr 12, 2025
43197c2
compress SVG
janosh Apr 12, 2025
c22840c
Merge branch 'main' into dot-module-graph
janosh Apr 12, 2025
720a74f
show hot-swapping-auto-batcher-hd.png diagram in HotSwappingAutoBatch…
janosh Apr 12, 2025
f6a4034
move module graph SVG from README.md to index.rst
janosh Apr 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Work-in-progress pull requests are encouraged, but please enable the draft statu

Before a pull request can be merged, the following items must be checked:

* [ ] Doc strings have been added in the [Numpy docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html).
* [ ] Doc strings have been added in the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google).
Run [ruff](https://beta.ruff.rs/docs/rules/#pydocstyle-d) on your code.
* [ ] Tests have been added for any new functionality or bug fixes.
* [ ] All linting and tests pass.
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ To understand how TorchSim works, start with the [comprehensive tutorials](https

TorchSim's structure is summarized in the [API reference](https://radical-ai.github.io/torch-sim/reference/index.html) documentation.

> `torch-sim` module graph. Each node represents a Python module. Arrows indicate imports between modules. Node color indicates connectedness: blue nodes have fewer dependents, red nodes have more (up to 16). The number in parentheses is the number of lines of code in the module.

## License

TorchSim is released under an [MIT license](LICENSE).
Expand Down
Loading
Loading