torchft 0.2.0__tar.gz

torchft-0.2.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,61 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make
+participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
+disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
+socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
+appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the
+project or its community in public spaces. Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting as an appointed representative at an
+online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
+<conduct@pytorch.org>. All complaints will be reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to
+the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
+repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

torchft-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to torchft
+
+We want to make contributing to this project as easy and transparent as possible.
+
+## TL;DR
+
+We appreciate all contributions. If you are interested in contributing to torchft, there are many ways to help out.
+Your contributions may fall into the following categories:
+
+- It helps the project if you can
+
+  - Report issues that you're facing
+  - Give a :+1: on issues that others reported and that are relevant to you
+
+- Answering questions on the issue tracker, investigating bugs are very valuable contributions to the project.
+
+- You would like to improve the documentation. This is no less important than improving the library itself! If you find
+  a typo in the documentation, do not hesitate to submit a GitHub pull request.
+
+- If you would like to fix a bug:
+
+  - comment on the issue that you want to work on this issue
+  - send a PR with your fix, see below.
+
+- If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the
+  feature with us.
+- If you would like to feature a usage example in our documentation, discuss that with us in an issue.
+
+## Issues
+
+We use GitHub issues to track public bugs. Please follow the existing templates if possible and ensure that the
+description is clear and has sufficient instructions to be able to reproduce the issue.
+
+## Development installation
+
+torchft is written in Python and Rust so you will need to install the Rust
+toolchain. [rustup](https://rustup.rs/) is recommended as it makes using tools such as linters much
+easier.
+
+Once you have rust installed you can install the project via:
+
+```
+$ pip install -e .[dev]
+```
+
+Also see the installation instructions in [the README](./README.md).
+
+## Pull Requests
+
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation and examples.
+4. Ensure the test suite passes.
+5. If you haven't already, complete the Contributor License Agreement ("CLA").
+
+### Code style
+
+`torchft` enforces a fairly strict code format with tools such as cargo fmt and black.
+
+```shell
+pip install lintrunner lintrunner-adapters
+lintrunner init
+lintrunner -a
+cargo +nightly fmt
+```
+
+### Tests
+
+We use `pytest` as our testing framework. To execute a specific test, use the following command:
+
+```sh
+pytest torchft/process_group_test.py -k test_device_mesh
+```
+
+To run the Rust tests run:
+
+```sh
+cargo test
+```
+
+To run the entire suite of tests:
+
+```sh
+$ scripts/test.sh
+```
+
+### Build Docs
+To build the docs run:
+```sh
+pip install -r docs/requirements.txt
+cd docs
+make livehtml
+```
+
+The docs will be built in the `docs/build/html` directory and served at http://localhost:8000.
+The page will be automatically re-built as long as the process is kept running.
+
+### Running Multiple Replica Local Job
+
+We use torchx to run multiple worker local test jobs. You need to run the
+lighthouse first and then you can use torchx to launch as many replica groups as
+you want. This uses the [train_ddp.py](./train_ddp.py) script.
+
+```sh
+$ torchft_lighthouse --min_replicas 2 --join_timeout_ms 10000 &
+$ torchx run -- --replicas 10
+```
+
+Once the Lighthouse has started you can view the status of all the workers at the Lighthouse dashboard.
+
+Default address is: http://localhost:29510
+
+## Contributor License Agreement ("CLA")
+
+In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of
+Facebook's open source projects.
+
+Complete your CLA here: <https://code.facebook.com/cla>
+
+## License
+
+By contributing to torchft, you agree that your contributions will be licensed under the LICENSE file in the root
+directory of this source tree.