Skip to content

Commit 46dc484

Browse files
authored
Merge branch 'dev' into dev
2 parents 08f9166 + 940c151 commit 46dc484

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

docs/install/index.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,11 @@ This step is not mandatory. But the latest `pip` install requires this or else w
4848

4949
=== "Windows"
5050
```bash
51-
python3 -m venv mlcflow
51+
python -m venv mlcflow
5252
mlcflow\Scripts\activate.bat
53+
```
54+
Run as Administrator
55+
```bash
5356
git config --system core.longpaths true
5457
```
5558

@@ -60,9 +63,14 @@ If you are not using virtual ENV for installation, the latest `pip` install requ
6063
```bash
6164
pip install mlcflow
6265
```
63-
66+
## Pull the Automation Repo
67+
```bash
68+
mlc pull repo mlcommons@mlperf-automations
69+
```
70+
* If you are forking https://github.com/mlcommons/mlperf-automations you can substitute the above command by `mlc pull repo <your_github_username>@mlperf-automations`.
71+
6472
!!! tip
65-
If you want to pull the latest changes (recommended), please do `mlc pull repo` after the installation.
73+
If you want to pull the latest changes (recommended), please do `mlc pull repo` periodically.
6674

6775

6876
Now, you are ready to use the `mlc` commands. Currently, `mlc` is being used to automate the benchmark runs for:

docs/targets/script/execution-flow.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ When we run an MLC script we can also pass inputs to it and any input added in `
3636
We can use `skip_if_env` dictionary inside any `deps`, `prehook_deps`, `posthook_deps` or `post_deps` to make its execution conditional
3737

3838
### Versions
39-
We can specify any specific version of a script using `version`. `version_max` and `version_min` are also possible options.
39+
We can specify any specific version of a script using `version`. `version_max`, `version_min` and `version_max_usable` are also possible options.
4040

41-
* When `version_min` is given, any version above this if present in the cache or detected in the system can be chosen. If nothing is detected `default_version` if present and if above `version_min` will be used for installation. Otherwise `version_min` will be used as `version`.
41+
* When `version_min` is given, any version above this if present in the cache or detected in the system can be chosen. If nothing is detected `default_version` if present and if above `version_min` will be used for installation. Otherwise `version_max_usable` if present or else `version_min` will be used as `version`.
4242

4343
* When `version_max` is given, any version below this if present in the cache or detected in the system can be chosen. If nothing is detected `default_version` if present and if below `version_max` will be used for installation. Otherwise `version_max_usable` (additional needed input for `version_max`) will be used as `version`.
44-
44+
4545
### Variations
46-
* Variations are used to customize MLC script and each unique combination of variations uses a unique cache entry. Each variation can turn on `env` keys also any other meta including dependencies specific to it. Variations are turned on like tags but with a `_` prefix. For example, if a script is having tags `"get,myscript"`, to call the variation `"test"` inside it, we have to use tags `"get,myscript,_test"`.
46+
* Variations are used to customize MLC script and each set of variations uses a unique cache entry. A variation can turn on `env` keys and any other meta including dependencies specific to it. Variations are turned on like tags but with a `_` prefix. For example, if a script is having tags `"get,myscript"`, to call the variation `"test"` inside it, we can use tags `"get,myscript,_test"`.
4747

4848
#### Variation groups
4949
`group` is a key to map variations into a group and at any time only one variation from a group can be used in the variation tags. For example, both `cpu` and `cuda` can be two variations under the `device` group, but user can at any time use either `cpu` or `cuda` as variation tags but not both.
@@ -63,6 +63,7 @@ Sometimes it is difficult to add all variations needed for a script like say `ba
6363
* Similarly we can avoid any env key from being passed to a given dependency by adding the prefix of the key in the `clean_env_keys` list of the concerned dependency.
6464
* `--input` is automatically converted to `MLC_INPUT` env key
6565
* `version` is converted to `MLC_VERSION`, ``version_min` to `MLC_VERSION_MIN` and `version_max` to `MLC_VERSION_MAX`
66+
* `mlc
6667
* If `env['MLC_GH_TOKEN']=TOKEN_VALUE` is set then git URLs (specified by `MLC_GIT_URL`) are changed to add this token.
6768
* If `env['MLC_GIT_SSH']=yes`, then git URLs are changed to SSH from HTTPS.
6869

0 commit comments

Comments
 (0)