Installation and Setup

Sign up for a free account and get started with SigOpt today!

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

Python

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")

Bash

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"
} 

Java

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

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

Pass your API token directly, overriding any environment variables

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

R

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 the SigOptR package directly from CRAN:

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

Latest Version from GitHub

Install the latest SigOptR package from GitHub by using devtools:

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

MATLAB

You can use our SigOpt Toolbox to call API endpoints.

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

Proxies

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

Python

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 documentation for the requests module for more information.

Bash

export http_proxy='http://10.10.1.10:3128'
export https_proxy='http://user:pass@10.10.1.10:1080'

Java

import com.sigopt.Sigopt;
Sigopt.setConnectionProxy(host, port);
Sigopt.setProxyCredential(new java.net.PasswordAuthentication(username, password));