|
17 | 17 |
|
18 | 18 | </details>
|
19 | 19 |
|
20 |
| - |
21 |
| -***Check our new [online installation GUI](https://access.cknowledge.org/playground/?action=install)***. |
| 20 | +**Last revision of this document: September 29, 2024** |
22 | 21 |
|
23 | 22 |
|
24 | 23 | # CM installation
|
25 | 24 |
|
26 | 25 |
|
27 | 26 |
|
28 |
| - |
29 | 27 | MLCommons Collective Mind framework requires minimal dependencies to run on any platform: `python 3+, pip, git, git-lfs, wget`.
|
30 | 28 | However, most CM automation recipes shared by the community and MLCommons require Python 3.7+ .
|
31 | 29 |
|
32 | 30 | ***By default, CM will pull Git repositories and cache installations and downloaded files in your `$HOME/CM` directory (Linux/MacOS).
|
33 | 31 | You can change it to any another directory using the `CM_REPOS` environment variable, for example `export CM_REPOS=/scratch/CM`.***
|
34 | 32 |
|
| 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 | + |
35 | 39 | Here are typical installation procedures across different operating systems:
|
36 | 40 |
|
37 | 41 | * [Ubuntu, Debian](#ubuntu-debian)
|
@@ -173,6 +177,7 @@ python -m pip install cmind
|
173 | 177 | *We plan to provide a self-sustained package in the future to simplify CM installation on Windows.*
|
174 | 178 |
|
175 | 179 |
|
| 180 | + |
176 | 181 | # CM CLI testing
|
177 | 182 |
|
178 | 183 | 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
|
205 | 210 | Joining the open MLPerf workgroup: https://cKnowledge.org/mlcommons-taskforce
|
206 | 211 | ```
|
207 | 212 |
|
| 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 | + |
208 | 231 | # CUDA installation
|
209 | 232 |
|
210 | 233 | If you plan to use CUDA for your experiments, please follow [this guide](installation-cuda.md)
|
|
0 commit comments