ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-03-03 18:52:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
allegroai 2021-02-27 23:53:06 +02:00
parent 88cd7071f2
commit 76f7822119
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/clearml-task.md
View File

@ -38,10 +38,10 @@ will be logged in real-time, alongside your TensorBoard and matplotlib.
### Launching a job from a repository ### Launching a job from a repository
We will be launching this [script](https://github.com/allegroai/trains/blob/master/examples/frameworks/scikit-learn/sklearn_matplotlib_example.py) on a remote machine. The following are the command-line options we will be using: We will be launching this [script](https://github.com/allegroai/trains/blob/master/examples/frameworks/scikit-learn/sklearn_matplotlib_example.py) on a remote machine. The following are the command-line options we will be using:
- First, we have to give the experiment a name and select a project (`--project examples --name remote_test`) 1. Give the experiment a name and select a project, for example: `--project examples --name remote_test`
- Then, we select the repository with our code. If we do not specify branch / commit, it will take the latest commit 2. Select the repository with our code. If we do not specify branch / commit, it will take the latest commit
from the master branch (`--repo https://github.com/allegroai/clearml.git`) from the master branch, for example: `--repo https://github.com/allegroai/clearml.git`
- Lastly, we need to specify which script in the repository needs to be run (`--script examples/frameworks/scikit-learn/sklearn_matplotlib_example.py`) 3. Specify which script in the repository needs to be run, for example: `--script examples/frameworks/scikit-learn/sklearn_matplotlib_example.py`
Notice that by default, the execution working directory will be the root of the repository. If we need to change it, add `--cwd <folder>` Notice that by default, the execution working directory will be the root of the repository. If we need to change it, add `--cwd <folder>`
If we additionally need to pass an argument to our scripts, use the `--args` switch. If we additionally need to pass an argument to our scripts, use the `--args` switch.
@ -81,11 +81,11 @@ clearml-task --help
``` ```
``` console ``` console
ClearML launch - launch any codebase on remote machines running clearml-agent ClearML launch - launch any codebase on remote machine running clearml-agent
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
--version Display the Allegro.ai utility version --version Display the clearml-task utility version
--project PROJECT Required: set the project name for the task. If --project PROJECT Required: set the project name for the task. If
--base-task-id is used, this arguments is optional. --base-task-id is used, this arguments is optional.
--name NAME Required: select a name for the remote task --name NAME Required: select a name for the remote task
@ -125,12 +125,17 @@ optional arguments:
Manually specify a list of required packages. Example: Manually specify a list of required packages. Example:
--packages "tqdm>=2.1" "scikit-learn" --packages "tqdm>=2.1" "scikit-learn"
--docker DOCKER Select the docker image to use in the remote session --docker DOCKER Select the docker image to use in the remote session
--task-type TASK_TYPE
Set the Task type, optional values: training, testing,
inference, data_processing, application, monitor,
controller, optimizer, service, qc, custom
--skip-task-init If set, Task.init() call is not added to the entry --skip-task-init If set, Task.init() call is not added to the entry
point, and is assumed to be called in within the point, and is assumed to be called in within the
script. Default: add Task.init() call entry point script. Default: add Task.init() call entry point
script script
--base-task-id BASE_TASK_ID --base-task-id BASE_TASK_ID
Use a pre-existing task in the system, instead of a local repo/script. Use a pre-existing task in the system, instead of a
Essentially clones an existing task and overrides arguments/requirements. local repo/script. Essentially clones an existing task
and overrides arguments/requirements.
``` ```