Installation and Setup
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
Bash
Java
R
MATLAB
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.install.packages("SigOptR", repos = "http://cran.us.r-project.org")
library(SigOptR)
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.
The SigOpt MATLAB library is a custom toolbox by SigOpt. Follow the installation instructions on GitHub.
If you are connecting to SigOpt behind a proxy, you may need to configure your client appropriately.
Python
Bash
Java
from sigopt import Connection
conn = Connection(client_token="USER_TOKEN")
conn.set_proxies({
'http': 'http://10.10.1.10:3128',
'https': 'http://user:[email protected]:1080',
})
export http_proxy='http://10.10.1.10:3128'
export https_proxy='http://user:[email protected]:1080'
import com.sigopt.Sigopt;
Sigopt.setConnectionProxy(host, port);
Sigopt.setProxyCredential(new java.net.PasswordAuthentication(username, password));
Last modified 8mo ago