Split dataset

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/split \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "trainingSplitRatio": 123,
  "testingSplitRatio": 123,
  "validationSplitRatio": 123,
  "excludeDisabledSamples": false,
  "stratifyBy": {
    "label": true,
    "metadataKeys": [
      "<string>"
    ]
  },
  "keepTogetherMetadataKeys": [
    "<string>"
  ]
}
'

{
  "success": true,
  "error": "<string>"
}

Split dataset

Performs a deterministic, in-place split of the project's dataset into "training", "testing", and optional "validation" sets. Split balancing can use the label, one or more metadata keys, or both as a composite grouping signal. Related samples can also be kept together across splits by metadata key. This is a deterministic process based on the hash of the name of the data. Returns immediately on small datasets, or starts a job on larger datasets. For example: { "trainingSplitRatio": 0.8, "testingSplitRatio": 0.1, "validationSplitRatio": 0.1, "excludeDisabledSamples": false, "stratifyBy": { "label": true, "metadataKeys": ["site", "scanner"] }, "keepTogetherMetadataKeys": ["capture_group"] } With these options, label/site/scanner are used to balance the split, while samples sharing the same capture_group value stay in the same split bucket.

POST

api

{projectId}

split

Split dataset

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/split \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "trainingSplitRatio": 123,
  "testingSplitRatio": 123,
  "validationSplitRatio": 123,
  "excludeDisabledSamples": false,
  "stratifyBy": {
    "label": true,
    "metadataKeys": [
      "<string>"
    ]
  },
  "keepTogetherMetadataKeys": [
    "<string>"
  ]
}
'

{
  "success": true,
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

projectId

integer

required

Project ID

Body

application/json

trainingSplitRatio

number

required

Proportion of the dataset to use for training.

testingSplitRatio

number

required

Proportion of the dataset to use for testing.

validationSplitRatio

number

Proportion of the dataset to use for validation. This is experimental and may change in the future.

excludeDisabledSamples

boolean

default:false

Whether to exclude samples that are marked as disabled.

stratifyBy

object

Optional balancing targets for the split.

Show child attributes

keepTogetherMetadataKeys

string[]

List of metadata keys whose matching values must stay together in a single split. This is useful for leakage prevention across train, validation, and test.

Response

200 - application/json

Option 1
Option 2

success

boolean

required

Whether the operation succeeded

error

string

Optional error description (set if 'success' was false)

Rebalance dataset

Split dataset preview

⌘I