Raw data

Split dataset preview

Returns a preview of how the project's dataset would be split if the current split options were applied. For each group (composite of label and/or metadata keys, or keep-together group), shows the number and percentage of samples that would be assigned to each split. This does not update the dataset, only provides a summary. Returns immediately on small datasets, or starts a job on larger datasets.

post/api/{projectId}/split-preview

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/split-preview/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Request body

trainingSplitRationumber required

Proportion of the dataset to use for training.

testingSplitRationumber required

Proportion of the dataset to use for testing.

validationSplitRationumber

Proportion of the dataset to use for validation.

excludeDisabledSamplesboolean

Whether to exclude samples that are marked as disabled.

keepTogetherMetadataKeysstring[]

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

Example response

{
  "id": 12873488112
}

Changes

No recorded changes to this operation across all 1 revision of this API.