LogoLogo
sigopt.comLog In / Sign Up
  • Welcome to SigOpt!
    • SigOpt API Modules
    • Main Concepts
      • Define and Set Up Parameter Space
      • Define and Set Up Metric Space
      • Alternative Experiment Types
  • Advanced Experimentation
    • Multimetric Optimization
    • Metric Thresholds
    • Metric Constraints
    • Metric Failure
    • All Constraints Experiment
    • Multisolution
    • Parallelism
    • Parameter Constraints
    • Prior Beliefs
    • Multitask Experiments
  • Core Module API References
    • Installation and Setup
    • Quick Start
    • API Topics
      • API Tokens and Authentication
      • API Errors
      • Manage Open Suggestions
      • Metadata
      • Pagination
    • API Endpoints
      • Client Detail
      • Experiment Best Assignments
      • Experiment Create
      • Experiment Delete
      • Experiment Detail
      • Experiment Metric Importances
      • Experiment Stopping Criteria
      • Experiment Update
      • Observation Create
      • Observation Batch Create
      • Observation Delete
      • Observation Detail
      • Observation List Delete
      • Observation List
      • Observation Update
      • Queued Suggestion Create
      • Queued Suggestion Delete
      • Queued Suggestion Detail
      • Queued Suggestion List
      • Suggestion Create
      • Suggestion Delete
      • Suggestion Detail
      • Suggestion List Delete
      • Suggestion List
      • Experiment Token Create
      • Organization Detail
      • Suggestion Update
    • API Objects
      • Assignments Object
      • Best Assignments Object
      • Bounds Object
      • Categorical Value Object
      • Client Object
      • Conditional Object
      • Conditions Object
      • Constraint Term Object
      • Experiment Object
      • Metadata Object
      • Metric Object
      • Metric Evaluation Object
      • Metric Importances Object
      • Observation Object
      • Organization Object
      • Pagination Object
      • Parameter Object
      • Parameter Constraint Object
      • Plan Object
      • Plan Period Object
      • Plan Rules Object
      • Prior Object
      • Progress Object
      • Queued Suggestion Object
      • Stopping Criteria Object
      • Suggestion Object
      • Token Object
  • AI MODULE API REFERENCES
    • Installation and Setup
    • Quick Start Tutorials
      • Run Tutorial
      • Project Tutorial
      • AI Experiment and Optimization Tutorial
    • Tracking Your Training Runs
      • Set Up for Example Code
      • Record SigOpt Runs in Jupyter
      • Record SigOpt Runs with Python IDE and SigOpt CLI
      • Record SigOpt Runs with Python IDE
      • View and Analyze the Recorded SigOpt Run
      • Enable Optimization for your SigOpt Runs
    • AI Experiments
      • AI Experiment Set Up
    • Bring Your Own Optimizer
    • XGBoost Integration
      • Installation
      • Tracking XGBoost Training
      • Tuning XGBoost Models
    • HyperOpt
      • Installation
      • User Case
      • API
    • SigOpt Orchestrate
      • Install SigOpt Orchestrate
      • Orchestrate a Tracked Training Run
      • Orchestrate an AI Experiment
      • AWS Cluster Create and Manage
      • SigOpt: Bring Your Own Cluster
      • Dockerfile: Define Your Environment
      • Debugging
      • CLI Reference
    • API Reference
      • Manually create a SigOpt Run
      • Tracking a Run
      • AI Experiment Client Calls
      • Project Client Calls
      • Objects
        • Training Run Object
        • AI Experiment Object
        • Parameter Object
        • Metric Object
      • SigOpt CLI Commands
      • Orchestrate CLI Commands
  • Support
    • Support
    • FAQ
    • Best Practices
      • Setting an experiment budget
      • Reproducibility in SigOpt
      • Uploading data as a Training Run artifact
      • Navigating multiple metrics
Powered by GitBook
On this page
  1. Core Module API References

Installation and Setup

PreviousMultitask ExperimentsNextQuick Start

Last updated 1 year ago

Once you have signed up for an account, you may set the SIGOPT_API_TOKEN environment variable. You can find your tokens on the

Install the Python Client

$ pip install sigopt

Alternatively, you can manually set the API token in Python.

from sigopt import Connection
conn = Connection(client_token="USER_TOKEN")

If you are a Bash user, you do not need to install any client. You can verify that you have access to SigOpt with the following command.

curl -X GET -u "$SIGOPT_API_TOKEN:" "https://api.sigopt.com/v1/tokens/self"

You should be able to see a JSON response similar to the following

{
  "all_experiments": true,
  "client": "1",
  "development": false,
  "experiment": null,
  "expires": null,
  "lease_length": null,
  "object": "token",
  "organization": "1",
  "permissions": "write",
  "scope": "all_endpoints",
  "token": "SIGOPT_API_TOKEN",
  "token_type": "client-api",
  "training_run": null,
  "user": "12345"
} 

You can use our official Java API client to call API endpoints.

Pass your API token directly, overriding any environment variables

import com.sigopt.Sigopt;
Sigopt.clientToken = "USER_TOKEN";

You can install the SigOptR package directly from CRAN, or you can use the devtools package to grab the latest version from GitHub.

CRAN

install.packages("SigOptR", repos = "http://cran.us.r-project.org")
library(SigOptR)

Latest Version from GitHub

install.packages("devtools", repos = "http://cran.us.r-project.org")
library(devtools)
install_github("sigopt/SigOptR")
library(SigOptR)

You can use our SigOpt Toolbox to call API endpoints.

Proxies

If you are connecting to SigOpt behind a proxy, you may need to configure your client appropriately.

from sigopt import Connection
conn = Connection(client_token="USER_TOKEN")
conn.set_proxies({
  'http': 'http://10.10.1.10:3128',
  'https': 'http://user:pass@10.10.1.10:1080',
})

See the for more information.

export http_proxy='http://10.10.1.10:3128'
export https_proxy='http://user:pass@10.10.1.10:1080'
import com.sigopt.Sigopt;
Sigopt.setConnectionProxy(host, port);
Sigopt.setProxyCredential(new java.net.PasswordAuthentication(username, password));

The SigOpt java library is available from Maven. Follow the installation instructions on .

Install the SigOptR package directly from :

Install the latest SigOptR package from by using devtools:

The SigOpt MATLAB library is a custom toolbox by SigOpt. Follow the installation instructions on .

GitHub
CRAN
GitHub
GitHub
API Tokens page.
documentation for the requests module