Skip to content

README and documentation #25

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

Jump to bottom
Closed
apoorvkh opened this issue Jun 9, 2024 · 3 comments · Fixed by #70
Closed

README and documentation #25

apoorvkh opened this issue Jun 9, 2024 · 3 comments · Fixed by #70
Labels
documentation Improvements or additions to documentation

Comments

@apoorvkh
Copy link
Owner

apoorvkh commented Jun 9, 2024

(for later)
@apoorvkh
Copy link
Owner Author

apoorvkh commented Jul 5, 2024

  • should add comments and docstrings to code
  • render the functions in __init__.py in readthedocs

@apoorvkh
Copy link
Owner Author

Also include submitit example with slurm

@apoorvkh
Copy link
Owner Author

Dummy example for distributed test

https://github.com/facebookincubator/submitit/blob/07f21fa1234e34151874c00d80c345e215af4967/docs/examples/torch_distributed.py#L55-L63

Underneath that say: "could also do (e.g. DDP/FSDP) PyTorch training"

@apoorvkh apoorvkh added the documentation Improvements or additions to documentation label Sep 26, 2024
@pmcurtin pmcurtin linked a pull request Sep 30, 2024 that will close this issue
docs (draft 1) #70
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs (draft 1) apoorvkh/torchrunx
1 participant
@apoorvkh