Skip to content

Commit bf0049e

Browse files
tall-joshjonochang
authored andcommitted
add extra prerequisite
1 parent 330937a commit bf0049e

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

content/docs/user-manual/agents/train-an-ml-capability.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ This tutorial expects you:
2121
1. You already have labelled data in a Highlighter _Assessment Workflow_
2222
2. You are using an existing _Model Template_ (ie: Training a model supported by Highlighter Training, not a custom model)
2323
3. You have the Highlighter CLI installed and configured
24+
4. Local [Highlighter Credentials](../../reference/sdk/highlighter-credentials.md)
2425

2526
## Training Workflows
2627

@@ -45,6 +46,12 @@ The streamlined command-line approach:
4546

4647
## CLI Workflow (Recommended)
4748

49+
**Before you start**: You must either have your Highlighter credentials exported
50+
as environment variables, or use the `--profile NAME` option for all `hl` commands.
51+
In the following examples, it is assumed the credentials are exported. See
52+
[Highlighter Credentials](../../reference/sdk/highlighter-credentials.md) for more
53+
information.
54+
4855
### Generate Training Boilerplate
4956

5057
First, generate the training configuration and download the required datasets:
@@ -55,7 +62,7 @@ hl generate training-run <TRAINING_RUN_ID> <TRAINER_TYPE> [ML_TRAINING_DIR]
5562

5663
**Parameters:**
5764
- `TRAINING_RUN_ID`: The ID of your Highlighter Training Run
58-
- `TRAINER_TYPE`: Currently supports `yolo-det` for YOLO detection models
65+
- `TRAINER_TYPE`: Currently supports `yolo-det|yolo-seg|yolo-cls` for YOLO detection models
5966
- `ML_TRAINING_DIR`: Directory for training files (default: `./ml_training`)
6067

6168
**Example:**

0 commit comments

Comments
 (0)