Project Object
/clients/CLIENT_ID/projects/PROJECT_ID
Projects allow you to organize your SigOpt activity while you iterate on your experiments. You can create a new project from the Projects page. Many experiments can be added to a project on the Experiments page, and you can put new experiments directly in a project when you create them.
Fields
| Key | Type | Value |
|---|---|---|
client | string | The id of the Client for this project. |
created | int | The timestamp (in seconds since epoch) that this project was created. |
id | string | A unique ID for this project. You provide this when creating the project. |
metadata | Metadata | Optional user-provided object. See Using Metadata for more information. |
name | string | A user-specified name for this project. |
updated | int | The timestamp (in seconds since epoch) that this project was last updated. |
user | string | The id of the user who created this project. |
Supported Endpoints
| Method | URI | Description |
|---|---|---|
POST | /clients/CLIENT_ID/projects | Project Create |
GET | /clients/CLIENT_ID/projects/PROJECT_ID | Project Detail |
GET | /clients/CLIENT_ID/projects | Project List |
GET | /clients/CLIENT_ID/projects/PROJECT_ID/experiments | Project Experiment List |
PUT | /clients/CLIENT_ID/projects/PROJECT_ID | Project Update |
Example
{
"client": "1",
"created": 1560895206,
"id": "classification-models",
"metadata": null,
"name": "Classification Models",
"object": "project",
"updated": 1560895206,
"user": "1234"
}