Documentation

Welcome to the developer documentation for SigOpt. If you have a question you can’t answer, feel free to contact us!
Welcome to the new SigOpt docs! If you're looking for the classic SigOpt documentation then you can find that here. Otherwise, happy optimizing!

Orchestrate CLI Commands

CommandDescription
sigopt cluster run [-r/--run-file RUN_YML_FILE] [-p/--project PROJECT_ID] [EXECUTABLE_COMMAND ...]Execute a Run on your cluster.
sigopt cluster optimize [-r/--run-file RUN_YML_FILE] [-e/--experiment-file EXPERIMENT_YML_FILE] [-p/--project PROJECT_ID] [EXECUTABLE_COMMAND ...]Execute an Experiment on your cluster. See the Experimentation documentation for information on creating Experiment YAML files.
sigopt cluster cleanClean out the images in the remote Docker environment.
sigopt cluster stop [IDENTIFIER ...]Stop an in-progress Run or Experiment. Use the identifier run/[id] and experiment/[id] to stop a Run and Experiment respectively.
sigopt cluster status [IDENTIFIER ...]Show the status of a Run or Experiment on the cluster. Use the identifier run/[id] and experiment/[id] to check the status of a Run and Experiment respectively. Provide no arguments to check the status of the cluster.
sigopt cluster testTest that the cluster is ready and accessible.
sigopt cluster test-run [-r/--run-file RUN_YML_FILE] [-p/--project PROJECT_ID] [EXECUTABLE_COMMAND ...]Start a run on the cluster and show debugging information and logs. Accepts the same arguments as sigopt cluster run.
sigopt cluster connect -n/--cluster-name NAME [--provider [aws|custom]] [--kubeconfig KUBECONFIG] [--registry REGISTYRY]Connect to an existing cluster. Provide just --cluster-name and --provider aws to connect to a cluster created with Orchestrate. For other clusters, please refer to the Bring your own cluster documentation.
sigopt cluster create [-f/--filename CLUSTER_YML_FILE]Create your cluster using the SigOpt Cluster YAML file.
sigopt cluster destroyDestroy the connected cluster. Only AWS clusters created with this CLI are supported.
sigopt cluster disconnectDisconnect from the connected cluster.
sigopt cluster install-pluginsInstall/update plugins installed, used to prepare BYO clusters.
sigopt cluster update -f/--filename CLUSTER_YML_FILEUpdate the cluster configuration or update to a new version. Only for AWS clusters provisioned by the SigOpt CLI.
sigopt cluster kubectl [KUBECTL_ARGS ...]Access Kubectl commands through the SigOpt CLI to debug issues with your orchestrated jobs.

Check out the full Orchestrate reference here.