Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mila-iqia/milatools
Tools to connect to and interact with the Mila cluster
https://github.com/mila-iqia/milatools
Last synced: 7 days ago
JSON representation
Tools to connect to and interact with the Mila cluster
- Host: GitHub
- URL: https://github.com/mila-iqia/milatools
- Owner: mila-iqia
- License: mit
- Created: 2021-08-31T19:37:02.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T19:13:34.000Z (7 months ago)
- Last Synced: 2024-04-13T22:57:00.711Z (7 months ago)
- Language: Python
- Size: 329 KB
- Stars: 53
- Watchers: 9
- Forks: 10
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# milatools
The milatools package provides the `mila` command, which is meant to help with connecting to and interacting with the Mila cluster.
---
**Warning**
The `mila` command is meant to be used on your local machine. Trying to run it on the cluster will fail with an error
---
## Install
Requires Python >= 3.8
We recommend using [`uv`](https://docs.astral.sh/uv/) in order to use `milatools` in its own isolated environment instead of alterring your default Python environment or creating and activating a new one manually.
```bash
uv tool install milatools
```
_Alternatively_:
```bash
pip install milatools
```
Or, for bleeding edge version:
```bash
uv tool install git+https://github.com/mila-iqia/milatools.git
# OR
pip install git+https://github.com/mila-iqia/milatools.git
```
After installing `milatools`, start with `mila init`:
```bash
mila init
```
## Commands
### mila init
Set up your access to the mila cluster interactively. Have your username and password ready!
* Set up your SSH config for easy connection with `ssh mila`
* Set up your public key if you don't already have them
* Copy your public key over to the cluster for passwordless auth
* Set up a public key on the login node to enable ssh into compute nodes
* **new**: Add a special SSH config for direct connection to a **compute node** with `ssh mila-cpu`
### mila docs/intranet
* Use `mila docs ` to search the Mila technical documentation
* Use `mila intranet ` to search the Mila intranet
Both commands open a browser window. If no search terms are given you are taken to the home page.
### mila code
Connect a VSCode instance to a compute node. `mila code` first allocates a compute node using slurm (you can pass slurm options as well using `--alloc`), and then calls the `code` command with the appropriate options to start a remote coding session on the allocated node.
You can simply Ctrl+C the process to end the session.
```
usage: mila code [-h] [--cluster {mila,cedar,narval,beluga,graham}] [--alloc ...]
[--command VALUE] [--job VALUE] [--node VALUE] [--persist]
PATH
positional arguments:
PATH Path to open on the remote machine
options:
-h, --help show this help message and exit
--alloc ... Extra options to pass to slurm
--cluster {mila,cedar,narval,beluga,graham}
Which cluster to connect to.
--command VALUE Command to use to start vscode (defaults to "code" or the value
of $MILATOOLS_CODE_COMMAND)
--job VALUE Job ID to connect to
--node VALUE Node to connect to
--persist Whether the server should persist or not
```
For example:
```bash
mila code path/to/my/experiment
```
The `--alloc` option may be used to pass extra arguments to `salloc` when allocating a node (for example, `--alloc --gres=gpu:1` to allocate 1 GPU). `--alloc` should be at the end, because it will take all of the arguments that come after it.
If you already have an allocation on a compute node, you may use the `--node NODENAME` or `--job JOBID` options to connect to that node.
### mila serve
The purpose of `mila serve` is to make it easier to start notebooks, logging servers, etc. on the compute nodes and connect to them.
```
usage: mila serve [-h] {connect,kill,list,lab,notebook,tensorboard,mlflow,aim} ...
positional arguments:
{connect,kill,list,lab,notebook,tensorboard,mlflow,aim}
connect Reconnect to a persistent server.
kill Kill a persistent server.
list List active servers.
lab Start a Jupyterlab server.
notebook Start a Jupyter Notebook server.
tensorboard Start a Tensorboard server.
mlflow Start an MLFlow server.
aim Start an AIM server.
optional arguments:
-h, --help show this help message and exit
```
For example, to start jupyterlab with one GPU, you may write:
```bash
mila serve lab --alloc --gres gpu:1
```
You can of course write any SLURM arguments after `--alloc`.
Ending the connection will end the server, but the `--persist` flag can be used to prevent that. In that case you would be able to write `mila serve connect jupyter-lab` in order to reconnect to your running instance. Use `mila serve list` and `mila serve kill` to view and manage any running instances.