Skip to content

Commit 19c35ff

Browse files
committed
clean up docs
1 parent 753254a commit 19c35ff

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

docs/installation.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,25 @@
1717

1818
</details>
1919

20-
21-
***Check our new [online installation GUI](https://access.cknowledge.org/playground/?action=install)***.
20+
**Last revision of this document: September 29, 2024**
2221

2322

2423
# CM installation
2524

2625

2726

28-
2927
MLCommons Collective Mind framework requires minimal dependencies to run on any platform: `python 3+, pip, git, git-lfs, wget`.
3028
However, most CM automation recipes shared by the community and MLCommons require Python 3.7+ .
3129

3230
***By default, CM will pull Git repositories and cache installations and downloaded files in your `$HOME/CM` directory (Linux/MacOS).
3331
You can change it to any another directory using the `CM_REPOS` environment variable, for example `export CM_REPOS=/scratch/CM`.***
3432

33+
***We suggest you not to install `cm4mlops` package via PIP since you can't control installation of the CM framework and repositories
34+
and it doesn't handle CM errors properly - use a newer version of `cm init` after installing `cmind` package as described below.***
35+
36+
***Feel free to use the [online installation GUI](https://access.cknowledge.org/playground/?action=install)***.
37+
38+
3539
Here are typical installation procedures across different operating systems:
3640

3741
* [Ubuntu, Debian](#ubuntu-debian)
@@ -173,6 +177,7 @@ python -m pip install cmind
173177
*We plan to provide a self-sustained package in the future to simplify CM installation on Windows.*
174178

175179

180+
176181
# CM CLI testing
177182

178183
If the installation is successful, you can run the CM CLI as follows:
@@ -205,6 +210,24 @@ Reporting issues and ideas: https://github.com/mlcommons/ck/issues
205210
Joining the open MLPerf workgroup: https://cKnowledge.org/mlcommons-taskforce
206211
```
207212

213+
# CM init
214+
215+
Use the following command to test CM system dependencies (git, wget, curl, etc):
216+
217+
```bash
218+
cm init
219+
```
220+
221+
Note that it will also install stable `cm4mlops` repository with the automation recipes
222+
for MLOps and MLPerf.
223+
224+
You can skip installation of this repository and use the standard CM command to pull this repo
225+
as follows:
226+
```bash
227+
cm init --skip
228+
cm pull repo mlcommons@cm4mlops
229+
```
230+
208231
# CUDA installation
209232

210233
If you plan to use CUDA for your experiments, please follow [this guide](installation-cuda.md)

0 commit comments

Comments
 (0)