Comet Javascript SDK¶

> api.getVersion()
"v2"

> api.experimentMetadata('7387462874624747').then(result => {
    console.log(results);
  });

{'archived': false,
 'durationMillis': 72,
 'endTimeMillis': 1572435457349,
 'experimentKey': "5a67221477dc5d76b37d10adbe41486d",
 'experimentName': null,
 'optimizationId': null,
 'projectId': "0306c896110140a2aaa24e54dbb40e6b",
 'projectName': "my-project-name",
 'startTimeMillis': 1572435384908,
 'workspaceName': "myworkspace"
}

> api.experimentTags('7387462874624747').then(result => {
    console.log(results);
  });

['tag1', 'tag2', ...]

> api.workspaces().then(result => {
    console.log(results);
  });

['workspace1', 'workspace2', 'workspace3']

> api.projects('workspace').then(result => {
    console.log(results);
  });

[
 {
  "projectId": "NA",
  "projectName": "general",
  "projectDescription": "View all experiments that aren't assigned to a project.",
  "ownerUserName": "username",
  "workspaceId": "workspace ID",
  "workspaceName": "workspace name",
  "isPublic": false,
  "numberOfExperiments": 1,
  "lastUpdated": 1527183924215
 }
]

> api.projectNotes(projectId).then(result => {
    console.log(results);
  });

'# Heading\nMy notes.'

> api.projectMetadata(projectId).then(result => {
    console.log(results);
  });

{
 "public": true,
 "lastUpdated": 1587065944275,
 "numberOfExperiments": 5,
 "ownerUserName": "username",
 "projectDescription": "Project Description",
 "projectId": "aProjectId",
 "projectName": "Project Name",
 "workspaceName": "Name of the workspace"
}

> api.get().then(result => {
    console.log(results);
  });

['general', 'workspace1']

> api.get('workspace1').then(result => {
    console.log(results);
  });

[{"lastUpdated": 1572435457347,
  numberOfExperiments: 1,
  ownerUserName: "user",
  projectDescription: "Project Description",
  projectId: "0306c897310140a1aaa24ea4343430e6b",
  projectName: "project1",
  public: false,
  workspaceName: "user",
 }]

> api.get('workspace1/project1').then(result => {
    console.log(results);
  });

["4d51ea0c5ebb48eea3465f3ad0ba12b3", "dfae44c27ebe41ef9231fc35eae137e8", ...]

> api.get('workspace1/project1/4d51ea0c5ebb48eea3465f3ad0ba12b3').then(result => {
    console.log(results);
  });

 {
  "durationMillis": 0,
  "startTimeMillis": 1527184671290,
  "endTimeMillis": 1527184671290,
  "experimentKey": "4d51ea0c5ebb48eea3465f3ad0ba12b3",
  "experimentName": "someExperimentName",
  "optimizationId": "someOptimizationId",
  "archived": false,
  "projectName": "project1",
  "projectId": "someProjectId",
  "workspaceName": "workspace1",
 }

> api.experimentsByProjectName('workspace1', 'project1').then(result => {
    console.log(results);
  });

[
 {
  "durationMillis": 0,
  "startTimeMillis": 1527184671290,
  "endTimeMillis": 1527184671290,
  "experimentKey": "someExperimentKey",
  "experimentName": "someExperimentName",
  "optimizationId": "someOptimizationId",
  "archived": false,
  "projectName": "someProjectName",
  "projectId": "someProjectId",
  "workspaceName": "someWorkspaceName",
 }
]

> api.experimentsByProjectId('project-uuid').then(result => {
    console.log(results);
  });

[
 {
  "durationMillis": 0,
  "startTimeMillis": 1527184671290,
  "endTimeMillis": 1527184671290,
  "experimentKey": "someExperimentKey",
  "experimentName": "someExperimentName",
  "optimizationId": "someOptimizationId",
  "archived": false,
  "projectName": "someProjectName",
  "projectId": "someProjectId",
  "workspaceName": "someWorkspaceName",
 }
]

> api.experimentHtml('experimentKey1').then(result => {
    console.log(results);
  });

'<b>The HTML</b>'

> api.experimentCode('experimentKey1').then(result => {
    console.log(results);
  });

'print("The Source Code")'

> api.experimentOutput('experimentKey1').then(result => {
    console.log(results);
  });

'The Output of the Program'

> api.experimentInstalledPackages('experimentKey1').then(result => {
    console.log(results);
  });

['pip=19.01', 'comet=1.0.28']

> api.experimentSystemDetails('experimentKey1').then(result => {
    console.log(results);
  });

{command: ["/usr/local/bin/pytest", ...],
 executable: "/usr/local/bin/python",
 experimentKey: "4d51ea0c5ebb48eea3465f3ad0ba12b3",
 gpuStaticInfoList: [],
 hostname: "b94cd9a8ee38",
 installedPackages: ["atomicwrites==1.3.0", ...],
 ip: "172.19.0.5",
 logAdditionalSystemInfoList: [],
 maxTotalMemory: null,
 networkInterfaceIps: (2) ["127.0.0.1", "172.19.0.5"],
 os: "Linux-4.15.0-1057-oem-x86_64-with-debian-10.1",
 osPackages: [],
 osType: "Linux",
 pid: 6,
 pythonVersion: "3.6.9",
 pythonVersionVerbose: "3.6.9 (default, Sep 12 2019, 16:23:48) \n[GCC 8.3.0]",
 systemMetricNames: ["sys.cpu.percent.01", ...],
 totalRam: null,
 user: "root",
}

> api.experimentGraph('experimentKey1').then(result => {
    console.log(results);
  });

'Network()'

> api.experimentImages('experimentKey1').then(result => {
    console.log(results);
  });

[
 {
  "apiKey": "someApiKey",
  "runId": "someRunId0123456789012345",
  "experimentKey": "someExperimentKey",
  "projectId": null,
  "figCounter": 123,
  "figName": "imageName",
  "step": 12312,
  "runContext": "contextA",
  "fileName": "file.py",
  "imagePath": "https://comet-ml.nyc3.digitaloceanspaces.com/file.py"
 }
]

> api.experimentParameters('experimentKey1').then(result => {
    console.log(result);
  });

[
 {
  "name": "nameA",
  "valueMax": "valueA",
  "valueMin": "valueA",
  "valueCurrent": "valueA",
  "timestampMax": 1527266735622,
  "timestampMin": 1527266735622,
  "timestampCurrent": 1527266735622,
  "runContextMax": "",
  "runContextMin": "",
  "runContextCurrent": "",
  "stepMax": null,
  "stepMin": null,
  "stepCurrent": null
 },
 {
  "name": "nameB",
  "valueMax": "valueB",
  "valueMin": "valueB",
  "valueCurrent": "valueB",
  "timestampMax": 1538888303,
  "timestampMin": 1538888303,
  "timestampCurrent": 1538888303,
  "runContextMax": "",
  "runContextMin": "",
  "runContextCurrent": "",
  "stepMax": null,
  "stepMin": null,
  "stepCurrent": null
 }
]

> api.experimentParameters('experimentKey1', 'nameA').then(result => {
    console.log(result);
  });

[
 {
  "name": "nameA",
  "valueMax": "valueA",
  "valueMin": "valueA",
  "valueCurrent": "valueA",
  "timestampMax": 1527266735622,
  "timestampMin": 1527266735622,
  "timestampCurrent": 1527266735622,
  "runContextMax": "",
  "runContextMin": "",
  "runContextCurrent": "",
  "stepMax": null,
  "stepMin": null,
  "stepCurrent": null
 }
]

> api.experimentMetricsSummary('experimentKey1', 'someNameA').then(result => {
    console.log(results);
  });

{
  "name": "someNameA",
  "valueMax": "1.123",
  "valueMin": "1.123",
  "valueCurrent": "1.123",
  "timestampMax": 1527266664729,
  "timestampMin": 1527266664729,
  "timestampCurrent": 1527266664729,
  "runContextMax": null,
  "runContextMin": null,
  "runContextCurrent": null,
  "stepMax": null,
  "stepMin": null,
  "stepCurrent": null
}

> api.experimentMetricsSummary('experimentKey1').then(result => {
    console.log(results);
  });

[
 {
  "name": "someNameA",
  "valueMax": "1.123",
  "valueMin": "1.123",
  "valueCurrent": "1.123",
  "timestampMax": 1527266664729,
  "timestampMin": 1527266664729,
  "timestampCurrent": 1527266664729,
  "runContextMax": null,
  "runContextMin": null,
  "runContextCurrent": null,
  "stepMax": null,
  "stepMin": null,
  "stepCurrent": null
 },
 {
  "name": "someNameB",
  "valueMax": "42",
  "valueMin": "40",
  "valueCurrent": "41",
  "timestampMax": 1727266664729,
  "timestampMin": 1727266664729,
  "timestampCurrent": 1727266664729,
  "runContextMax": null,
  "runContextMin": null,
  "runContextCurrent": null,
  "stepMax": null,
  "stepMin": null,
  "stepCurrent": null
 }
]

> api.experimentOther('experimentKey1').then(result => {
    console.log(results);
  });

[
 {
   "name": "key",
   "valueMax": "value",
   "valueMin": "value",
   "valueCurrent": "value",
   "timestampMax": 1527266796121,
   "timestampMin": 1527266796121,
   "timestampCurrent": 1527266796121,
   "runContextMax": null,
   "runContextMin": null,
   "runContextCurrent": null,
   "stepMax": null,
   "stepMin": null,
   "stepCurrent": null
 }
]

> api.experimentOther('experimentKey1', 'key').then(result => {
    console.log(results);
  });

{
   "name": "key",
   "valueMax": "value",
   "valueMin": "value",
   "valueCurrent": "value",
   "timestampMax": 1527266796121,
   "timestampMin": 1527266796121,
   "timestampCurrent": 1527266796121,
   "runContextMax": null,
   "runContextMin": null,
   "runContextCurrent": null,
   "stepMax": null,
   "stepMin": null,
   "stepCurrent": null
}

> api.experimentOther('experimentKey1', 'key', 'valueMax').then(result => {
    console.log(results);
  });

"value"

> api.experimentName('experimentKey1').then(result => {
    console.log(results);
  });
'name given via experiment.set_name("name")'

> api.experimentName('experimentKey1', 9)
'name give'

> api.experimentName('experimentKey1')
'09ce56129'

> api.experimentMetric('experimentKey1', 'batch').then(result => {
    console.log(results);
  });

[(null, "0")]

> api.experimentMetricsForChart(['5a67221477dc4dc6b38d10adbe41486d']).then(result => {
    console.log(results);
  });

{'5a67221477dc4dc6b38d10adbe41486d':
 {'empty': false,
  'epochs': null,
  'params': null,
  'steps': null,
  'experimentKey': "5a67221477dc4dc6b38d10adbe41486d",
  'metrics': [{'metricName': "acc", 'values': [], 'steps': [], 'epochs': [], 'timestamps': [], 'values': []}],
 }
}

> api.experimentAssets('experimentKey1').then(result => {
    console.log(results);
  });

[
 {
 "fileName": "file.py",
 "fileSize": 7,
 "runConext": "contextA",
 "step": 12312,
 "link": "https://www.comet.com/api/rest/v2/experiment/asset/get-asset?experimentKey=someExperimentKey&assetId=6YZYszn9cO9mhDoYrfuQlDLcE",
 "createdAt": 1544067813424,
 "dir": "assets"
 }
]

> api.experimentAssetByName('experimentKey1', 'file.py').then(result => {
    console.log(results);
  });

'the contents of the asset as string (Python 2)'

> api.experimentAssetByName('experimentKey1', 'file.py').then(result => {
    console.log(results);
  });

b'the contents of the asset as binary (Python 3)'

> api.experimentAssetByName('experimentKey1', 'file.json', 'json').then(result => {
    console.log(results);
  });

{someName: "value of key", someOther: [1, 2, 3]}

> api.experimentAssetByName('experimentKey1', 'file.data', 'json').then(result => {
    console.log(results);
  });

[[1], [2], [3]]

> api.experimentCurves('experimentKey1').then(curves => {
    console.log(curves);
  });

[{x: [1, 2, 3], y: [4, 5, 6], name: "mycurve"}, ...]

> api.experimentAsset('experimentKey1', '6YZYszn9cO9mhDoYrfuQlDLcE').then(result => {
    console.log(results);
  });

'the contents of the asset as string (Python 2)'

> api.experimentAsset('experimentKey1', '6YZYszn9cO9mhDoYrfuQlDLcE').then(result => {
    console.log(results);
  });

b'the contents of the asset as binary (Python 3)'

> api.experimentAsset('experimentKey1', '3873473463782746284762734', 'json').then(result => {
    console.log(results);
  });

{someName: "value of key", someOther: [1, 2, 3]}

> api.experimentAsset('experimentKey1', '9093487348374873487348731', 'json').then(result => {
    console.log(results);
  });

[[1], [2], [3]]

> api.store("text", "This is the text").then(result => {
    console.log(results);
  });

{"msg": "Stored"}

> api.getFromStore("text").then(result => {
    console.log(results);
  });

"This is the text"

> api.getStore().then(result => {
    console.log(results);
  });

{"store": "{...}"}