You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,12 @@ Key Features:
14
14
- Multiple transport backends (RDMA, regular TCP) for optimal performance
15
15
- Flexible storage volume management and sharding strategies
16
16
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.
20
23
21
24
## Installation
22
25
@@ -64,9 +67,7 @@ Once installed, you can import it in your Python code:
64
67
import torchstore
65
68
```
66
69
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).
70
71
71
72
## Usage
72
73
@@ -134,15 +135,11 @@ if __name__ == "__main__":
134
135
# checkout out tests/test_resharding.py for more e2e examples with resharding DTensor.
135
136
```
136
137
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
-
145
138
# Testing
146
139
147
140
Pytest is used for testing. For an examples of how to run tests (and get logs), see:
0 commit comments