Skip to content

Commit 73f42bd

Browse files
[Automated Commit] Document script/install-cuda-prebuilt/meta.yaml [skip ci]
1 parent eb74830 commit 73f42bd

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# README for install-cuda-prebuilt
2+
This README is automatically generated. Create and add custom content in info.md. Please follow the [script execution document](https://docs.mlcommons.org/mlcflow/targets/script/execution-flow/) to understand more about the MLC script execution.
3+
4+
`mlcflow` stores all local data under `$HOME/MLC` by default. So, if there is space constraint on the home directory and you have more space on say `/mnt/$USER`, you can do
5+
```
6+
mkdir /mnt/$USER/MLC
7+
ln -s /mnt/$USER/MLC $HOME/MLC
8+
```
9+
You can also use the `ENV` variable `MLC_REPOS` to control this location but this will need a set after every system reboot.
10+
11+
## Setup
12+
13+
If you are not on a Python development environment please refer to the [official docs](https://docs.mlcommons.org/mlcflow/install/) for the installation.
14+
15+
```bash
16+
python3 -m venv mlcflow
17+
. mlcflow/bin/activate
18+
pip install mlcflow
19+
```
20+
21+
- Using a virtual environment is recommended (per `pip` best practices), but you may skip it or use `--break-system-packages` if needed.
22+
23+
### Pull mlperf-automations
24+
25+
Once `mlcflow` is installed:
26+
27+
```bash
28+
mlc pull repo mlcommons@mlperf-automations --pat=<Your Private Access Token>
29+
```
30+
- `--pat` or `--ssh` is only needed if the repo is PRIVATE
31+
- If `--pat` is avoided, you'll be asked to enter the password where you can enter your Private Access Token
32+
- `--ssh` option can be used instead of `--pat=<>` option if you prefer to use SSH for accessing the github repository.
33+
## Run Commands
34+
35+
```bash
36+
mlcr install,prebuilt,cuda,prebuilt-cuda,install-prebuilt-cuda
37+
```
38+
39+
### Script Inputs
40+
41+
| Name | Description | Choices | Default |
42+
|------|-------------|---------|------|
43+
| `--install_prefix` | | | `` |
44+
| `--local_run_file_path` | | | `` |
45+
| `--override-driver-check` | | | `` |
46+
| `--skip_sudo` | | | `` |
47+
### Generic Script Inputs
48+
49+
| Name | Description | Choices | Default |
50+
|------|-------------|---------|------|
51+
| `--input` | Input to the script passed using the env key `MLC_INPUT` | | `` |
52+
| `--output` | Output from the script passed using the env key `MLC_OUTPUT` | | `` |
53+
| `--outdirname` | The directory to store the script output | | `cache directory ($HOME/MLC/repos/local/cache/<>) if the script is cacheable or else the current directory` |
54+
| `--outbasename` | The output file/folder name | | `` |
55+
| `--search_folder_path` | The folder path where executables of a given script need to be searched. Search is done recursively upto 4 levels. | | `` |
56+
| `--name` | | | `` |
57+
| `--extra_cache_tags` | Extra cache tags to be added to the cached entry when the script results are saved | | `` |
58+
| `--skip_compile` | Skip compilation | | `False` |
59+
| `--skip_run` | Skip run | | `False` |
60+
| `--skip_sudo` | Skip SUDO detection | | `False` |
61+
| `--accept_license` | Accept the required license requirement to run the script | | `False` |
62+
| `--skip_system_deps` | Skip installing any system dependencies | | `False` |
63+
| `--git_ssh` | Use SSH for git repos | | `False` |
64+
| `--gh_token` | Github Token | | `` |
65+
| `--hf_token` | Huggingface Token | | `` |
66+
| `--verify_ssl` | Verify SSL | | `False` |
67+
## Variations
68+
69+
### Install-driver
70+
71+
- `driver`
72+
- `no-driver` (default)

0 commit comments

Comments
 (0)