Skip to content

[torchstore] Rework the readme. #48

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 2 commits into from
Oct 1, 2025
Merged

[torchstore] Rework the readme. #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54c73ff
[torchstore] Rework the readme.
dcci Oct 1, 2025
c39744c
Update to account for Lucas' comments.
dcci Oct 1, 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
25 changes: 11 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@ Key Features:
- Multiple transport backends (RDMA, regular TCP) for optimal performance
- Flexible storage volume management and sharding strategies

# Under Construction!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can potentially add something back in like "we are in alpha"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


Nothing to see here yet, but check back soon
> ⚠️ **Early Development Warning** TorchStore is currently in an experimental
> stage. You should expect bugs, incomplete features, and APIs that may change
> in future versions. The project welcomes bugfixes, but to make sure things are
> well coordinated you should discuss any significant change before starting the
> work. It's recommended that you signal your intention to contribute in the
> issue tracker, either by filing a new issue or by claiming an existing one.

## Installation

Expand Down Expand Up @@ -64,9 +67,7 @@ Once installed, you can import it in your Python code:
import torchstore
```

Note: Setup currently assumes you have a working conda environment with both torch & monarch (this is currently a todo). For now the fastest way of setting up is going through [this](https://www.internalfb.com/wiki/Monarch/Monarch_xlformers_integration/Running_Monarch_on_Conda/#how-to-run-monarch) guide.

Protop: Install finetine conda & use the 'local' option for the latest packges
Note: Setup currently assumes you have a working conda environment with both torch & monarch (this is currently a todo).

## Usage

Expand Down Expand Up @@ -134,15 +135,11 @@ if __name__ == "__main__":
# checkout out tests/test_resharding.py for more e2e examples with resharding DTensor.
```

# Contributing Guidelines

1. Build in public -- TorchStore should be OSS first, giving users a clear vision on where we want to go and how to help us get there.

2. Build the Bicycle, not the super car -- Develop value iterively, instead of trying to ship everything at once.

3. Work backwards from use cases, and leave tests!

# Testing

Pytest is used for testing. For an examples of how to run tests (and get logs), see:
`TORCHSTORE_LOG_LEVEL=DEBUG pytest -vs --log-cli-level=DEBUG tests/test_models.py::test_main`

## License

Torchstore is BSD-3 licensed, as found in the [LICENSE](LICENSE) file.