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!

TrainingRun

KeyTypeDescription
assignmentsmap<string, number or string>The parameter values that were assigned to this SigOpt Run.
completedintThe timestamp (in seconds since epoch) that this SigOpt Run completed.
deletedbooleanIndicates that the SigOpt Run has been deleted.
datasetsarray<string>The name of the datasets that were recorded with the SigOpt Run.
logsmap<string, string>The logs that were recorded for this SigOpt Run. Maps the name of the log stream (ex. stdout) to the content of that stream.
experimentstringThe id of the Experiment that the SigOpt Run belongs to.
modelModelThe model that was recorded for this SigOpt Run. Model has a single type property.
source_codeSourceCodeThe source code that was recorded for this SigOpt Run. SourceCode has content and hash properties.
statestringThe state of the SigOpt Run. Can be active, completed, failed or deleted.
valuesmap<string, MetricEvaluation>The values of the metrics that were recorded for this SigOpt Run. MetricEvaluation has value, value_stddev, and name properties.
userstringThe id of the User that created this SigOpt Run.
filesarray<string>A list of ids of files that were uploaded with this SigOpt Run.
tagsarray<string>A list of ids of tags that are associated with this SigOpt Run.
favoritebooleanIndicates that the SigOpt Run has been favorited.
checkpoint_countintThe number of checkpoints associated with this SigOpt Run.
createdintThe timestamp (in seconds since epoch) that this SigOpt Run was created.
finishedbooleanWhether the SigOpt Run has finished and an observation has been created.
idstringA unique id for this SigOpt Run.
metadatamap<string, value>Metadata that was recorded during the execution of the SigOpt Run.
updatedintThe timestamp (in seconds since epoch) that this SigOpt Run was last updated.