Skip to content

Commit 39cf64b

Browse files
authored
Merge pull request #48 from meta-pytorch/readme-rework
[torchstore] Rework the readme.
2 parents 68a14fe + c39744c commit 39cf64b

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,12 @@ Key Features:
1414
- Multiple transport backends (RDMA, regular TCP) for optimal performance
1515
- Flexible storage volume management and sharding strategies
1616

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

@@ -64,9 +67,7 @@ Once installed, you can import it in your Python code:
6467
import torchstore
6568
```
6669

67-
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.
68-
69-
Protop: Install finetine conda & use the 'local' option for the latest packges
70+
Note: Setup currently assumes you have a working conda environment with both torch & monarch (this is currently a todo).
7071

7172
## Usage
7273

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

137-
# Contributing Guidelines
138-
139-
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.
140-
141-
2. Build the Bicycle, not the super car -- Develop value iterively, instead of trying to ship everything at once.
142-
143-
3. Work backwards from use cases, and leave tests!
144-
145138
# Testing
146139

147140
Pytest is used for testing. For an examples of how to run tests (and get logs), see:
148141
`TORCHSTORE_LOG_LEVEL=DEBUG pytest -vs --log-cli-level=DEBUG tests/test_models.py::test_main`
142+
143+
## License
144+
145+
Torchstore is BSD-3 licensed, as found in the [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)