@@ -50,18 +50,19 @@ View Monarch's hosted documentation [at this link](https://meta-pytorch.org/mona
50
50
## Installation
51
51
Note for running distributed tensors, the local torch version must match the version that monarch was built with.
52
52
53
- ### On Fedora distributions
54
- ## Stable
53
+ ### Stable
55
54
` pip install torchmonarch `
56
55
57
56
torchmonarch stable is built with the latest stable torch.
58
57
59
- ## Nightly
58
+ ### Nightly
60
59
` pip install torchmonarch-nightly `
61
60
62
61
torchmonarch-nightly is built with torch nightly.
63
62
64
- or manually
63
+ ### Build and Install from Source
64
+
65
+ #### On Fedora distributions
65
66
66
67
``` sh
67
68
@@ -99,11 +100,11 @@ pip install --no-build-isolation .
99
100
# or setup for development
100
101
pip install --no-build-isolation -e .
101
102
102
- # Run unit tests. consider -s for more verbose output
103
- pytest python/tests/ -v -m " not oss_skip "
103
+ # Verify installation
104
+ pip list | grep monarch
104
105
```
105
106
106
- ### On Ubuntu distributions
107
+ #### On Ubuntu distributions
107
108
108
109
``` sh
109
110
# Clone the repository and navigate to it
@@ -144,7 +145,7 @@ pip install --no-build-isolation -e .
144
145
pip list | grep monarch
145
146
```
146
147
147
- ### On MacOS
148
+ #### On MacOS
148
149
149
150
You can also build Monarch to run locally on a MacOS system.
150
151
@@ -172,6 +173,8 @@ USE_TENSOR_ENGINE=0 pip install --no-build-isolation .
172
173
# or setup for development
173
174
USE_TENSOR_ENGINE=0 pip install --no-build-isolation -e .
174
175
176
+ # Verify installation
177
+ pip list | grep monarch
175
178
```
176
179
177
180
@@ -181,6 +184,30 @@ Check out the `examples/` directory for demonstrations of how to use Monarch's A
181
184
182
185
We'll be adding more examples as we stabilize and polish functionality!
183
186
187
+ ## Running tests
188
+
189
+ We have both Rust and Python unit tests. Rust tests are run with ` cargo-nextest `
190
+ and Python tests are run with ` pytest ` .
191
+
192
+ Rust tests:
193
+ ``` sh
194
+ # We use cargo-nextest to run our tests, as they can provide strong process isolation
195
+ # between every test.
196
+ # Here we install it from source, but you can instead use a pre-built binary described
197
+ # here: https://nexte.st/docs/installation/pre-built-binaries/
198
+ cargo install cargo-nextest --locked
199
+ cargo nextest run
200
+ ```
201
+ cargo-nextest supports all of the filtering flags of "cargo test".
202
+
203
+ Python tests:
204
+ ``` sh
205
+ # Make sure to install test dependencies first
206
+ pip install -r python/tests/requirements.txt
207
+ # Run unit tests. consider -s for more verbose output
208
+ pytest python/tests/ -v -m " not oss_skip"
209
+ ```
210
+
184
211
## License
185
212
186
213
Monarch is BSD-3 licensed, as found in the [ LICENSE] ( LICENSE ) file.
0 commit comments