SigOpt CLI Commands

Search…
SigOpt CLI Commands
Get Started Commands
Command
Description
​sigopt config​
Same command to configure the API token and enable other features (logs and source code collection).
​sigopt init​
Create template files in the current directory to help you get started.
​sigopt version​
Show the version of the SigOpt CLI.
Runs CLI Commands
Command
Description
​sigopt run [-r/--run-file <RUN YML FILE>] [-p/--project <PROJECT_ID>] [EXECUTABLE COMMAND] 
Execute a Run from the indicated model execution code. An executable command must be provided, either as command arguments or via the run section of the provided run file (run.yml in the current directory by default). The Project can be specified manually, otherwise the SIGOPT_PROJECT environment variable or current directory name will be used.
Runs YAML File Formatting
Specify the configuration of a Run or Runs that are produced during an Experiment. When used with SigOpt Orchestrate, job resource specifications will be determined by the resources specified in the run.yml file.
Field
Required?
Description
image
Yes
Name of Docker container SigOpt Orchestrate creates. You can also point this to an existing Docker container to use for SigOpt Orchestrate.
name
Yes
Name for your SigOpt Run or HPO experiment
run
No
Model file to execute
resources
No
Resources to allocate to each Run. Can specify limits and requests for cpu, memory, ephemeral-storage and can specify GPUs.
1
# example Run yml file
2
name: My Run
3
run: python mymodel.py
4
resources:
5
 requests:
6
 cpu: 0.5
7
 memory: 512Mi
8
 limits:
9
 cpu: 2
10
 memory: 4Gi
11
 gpus: 1
12
image: my-run
Copied!
Experiments CLI Commands
Command
Description
​sigopt optimize [-e/--experiment-file <EXPERIMENT YML FILE>] [-p/--project <PROJECT_ID>] [EXECUTABLE COMMAND]​
Execute a SigOpt Experiment from the indicated execution code. Experiment settings must be provided, either with an experiment.yml file in the current directory or by manually specifying the file location. The Project can be specified manually, otherwise the SIGOPT_PROJECT environment variable or current directory name will be used.
​sigopt create experiment [-e/--experiment-file <EXPERIMENT YML FILE>] [-p/--project <PROJECT_ID>]​
Create a Sigopt Experiment using an experiment file. Execution of the Experiment should be done manually with the sigopt start-worker command, or by fetching the Experiment in your code.
​sigopt start-worker EXPERIMENT_ID [-r/--run-file run.yml] [EXECUTABLE COMMAND]​
This command starts a new Experiment worker. It has similar options to sigopt run, but requires an Experiment ID. If no commands are provided, the worker will use the run.yml file to specify execution.
Experiment YML File Formatting
Specify the configuration of a Run or Runs that are produced during an Experiment.
Field
Required?
Description
name
Yes
Name of the Experiment
type
Yes
Type of Search Experiment to execute (see table below)
parameters
Yes
Parameters and ranges specified for a SigOpt Experiment
metrics
Yes
Evaluation and storage metrics for a SigOpt Experiment 
parallel_bandwidth
No 
Number of workers
budget
Yes
Number of Runs for a SigOpt Experiment
Search Experiment Type
Type Flag
SigOpt Optimization Experiment
offline
All Constraints Experiment
offline
Grid Search
grid
Random Search
random
1
# single_metric_experiment.yml
2
name: Single metric optimization
3
type: offline
4
parameters:
5
 - name: hidden_layer_size
6
   type: int
7
   bounds:
8
     min: 32
9
     max: 512
10
 - name: activation_function
11
   type: categorical
12
   categorical_values: ['relu', 'tanh']
13
metrics:
14
 - name: holdout_accuracy
15
   strategy: optimize
16
   objective: maximize
17
parallel_bandwidth: 1
18
budget: 30
Copied!
Parameter Object
Orchestrate CLI Commands
Last modified 1mo ago
Copy link
Contents
Get Started Commands
Runs CLI Commands
Runs YAML File Formatting
Experiments CLI Commands
Experiment YML File Formatting