edge-impulse-api 1.92.15 → 1.92.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1399,7 +1399,7 @@ export declare class RawDataApi {
1399
1399
  };
1400
1400
  }): Promise<GenericApiResponse>;
1401
1401
  /**
1402
- * Performs a deterministic, in-place stratified split of the project\'s dataset into \"training\" and \"testing\" sets, based on the chosen stratification options. Stratification can use the label, one or more metadata keys, or both as a composite group. 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: { \"stratifyByLabel\": true, \"metadataKeys\": [\"site\", \"scanner\"], \"excludeDisabledSamples\": false, \"splitRatio\": 0.8 } With these options, samples are grouped by the combination of label, site, and scanner. Within each group, 80% are set to \"training\" and the rest to \"testing\".
1402
+ * Performs a deterministic, in-place stratified split of the project\'s dataset into \"training\", \"testing\", and optional \"validation\" sets, based on the chosen stratification options. Stratification can use the label, one or more metadata keys, or both as a composite group. 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: { \"stratifyByLabel\": true, \"metadataKeys\": [\"site\", \"scanner\"], \"excludeDisabledSamples\": false, \"trainingSplitRatio\": 0.8, \"testingSplitRatio\": 0.1, \"validationSplitRatio\": 0.1 } With these options, samples are grouped by the combination of label, site, and scanner. Within each group, 80% are set to \"training\", 10% to \"testing\", and 10% to \"validation\".
1403
1403
  * @summary Stratify dataset
1404
1404
  * @param projectId Project ID
1405
1405
  * @param datasetStratificationOptions
@@ -6301,7 +6301,7 @@ class RawDataApi {
6301
6301
  return this.handleResponse(response, 'GenericApiResponse');
6302
6302
  }
6303
6303
  /**
6304
- * Performs a deterministic, in-place stratified split of the project\'s dataset into \"training\" and \"testing\" sets, based on the chosen stratification options. Stratification can use the label, one or more metadata keys, or both as a composite group. 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: { \"stratifyByLabel\": true, \"metadataKeys\": [\"site\", \"scanner\"], \"excludeDisabledSamples\": false, \"splitRatio\": 0.8 } With these options, samples are grouped by the combination of label, site, and scanner. Within each group, 80% are set to \"training\" and the rest to \"testing\".
6304
+ * Performs a deterministic, in-place stratified split of the project\'s dataset into \"training\", \"testing\", and optional \"validation\" sets, based on the chosen stratification options. Stratification can use the label, one or more metadata keys, or both as a composite group. 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: { \"stratifyByLabel\": true, \"metadataKeys\": [\"site\", \"scanner\"], \"excludeDisabledSamples\": false, \"trainingSplitRatio\": 0.8, \"testingSplitRatio\": 0.1, \"validationSplitRatio\": 0.1 } With these options, samples are grouped by the combination of label, site, and scanner. Within each group, 80% are set to \"training\", 10% to \"testing\", and 10% to \"validation\".
6305
6305
  * @summary Stratify dataset
6306
6306
  * @param projectId Project ID
6307
6307
  * @param datasetStratificationOptions
@@ -11,11 +11,15 @@
11
11
  */
12
12
  export declare class DatasetRatioDataRatio {
13
13
  /**
14
- * number of training samples after rebalance
14
+ * Number of training samples after rebalance
15
15
  */
16
16
  'training'?: number;
17
17
  /**
18
- * number of testing samples after rebalance. This ignores test data with a label that\'s not in the training dataset.
18
+ * Number of validation samples after rebalance. This is experimental and may change in the future.
19
+ */
20
+ 'validation'?: number;
21
+ /**
22
+ * Number of testing samples after rebalance. This ignores test data with a label that\'s not in the training dataset.
19
23
  */
20
24
  'testing'?: number;
21
25
  static discriminator: string | undefined;
@@ -25,6 +25,11 @@ DatasetRatioDataRatio.attributeTypeMap = [
25
25
  "baseName": "training",
26
26
  "type": "number"
27
27
  },
28
+ {
29
+ "name": "validation",
30
+ "baseName": "validation",
31
+ "type": "number"
32
+ },
28
33
  {
29
34
  "name": "testing",
30
35
  "baseName": "testing",
@@ -1 +1 @@
1
- {"version":3,"file":"datasetRatioDataRatio.js","sourceRoot":"","sources":["../../../../library/sdk/model/datasetRatioDataRatio.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAGH,MAAa,qBAAqB;IAwB9B,MAAM,CAAC,mBAAmB;QACtB,OAAO,qBAAqB,CAAC,gBAAgB,CAAC;IAClD,CAAC;;AA1BL,sDA2BC;AAjBU,mCAAa,GAAuB,SAAS,CAAC;AAE9C,sCAAgB,GAA0D;IAC7E;QACI,MAAM,EAAE,UAAU;QAClB,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,SAAS;QACrB,MAAM,EAAE,QAAQ;KACnB;CAAK,CAAC"}
1
+ {"version":3,"file":"datasetRatioDataRatio.js","sourceRoot":"","sources":["../../../../library/sdk/model/datasetRatioDataRatio.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAGH,MAAa,qBAAqB;IAiC9B,MAAM,CAAC,mBAAmB;QACtB,OAAO,qBAAqB,CAAC,gBAAgB,CAAC;IAClD,CAAC;;AAnCL,sDAoCC;AAtBU,mCAAa,GAAuB,SAAS,CAAC;AAE9C,sCAAgB,GAA0D;IAC7E;QACI,MAAM,EAAE,UAAU;QAClB,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,YAAY;QACpB,UAAU,EAAE,YAAY;QACxB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,SAAS;QACrB,MAAM,EAAE,QAAQ;KACnB;CAAK,CAAC"}
@@ -11,9 +11,17 @@
11
11
  */
12
12
  export declare class DatasetStratificationOptions {
13
13
  /**
14
- * Proportion of the dataset to use for training. The remainder will be used for testing. For example, a value of 0.8 means 80% training, 20% testing.
14
+ * Proportion of the dataset to use for training.
15
15
  */
16
- 'splitRatio': number;
16
+ 'trainingSplitRatio': number;
17
+ /**
18
+ * Proportion of the dataset to use for testing.
19
+ */
20
+ 'testingSplitRatio': number;
21
+ /**
22
+ * Proportion of the dataset to use for validation. This is experimental and may change in the future.
23
+ */
24
+ 'validationSplitRatio'?: number;
17
25
  /**
18
26
  * Whether to stratify by label. If true, the label column will be used for stratification combined with metadataKeys. If false, only metadataKeys will be used.
19
27
  */
@@ -21,8 +21,18 @@ exports.DatasetStratificationOptions = DatasetStratificationOptions;
21
21
  DatasetStratificationOptions.discriminator = undefined;
22
22
  DatasetStratificationOptions.attributeTypeMap = [
23
23
  {
24
- "name": "splitRatio",
25
- "baseName": "splitRatio",
24
+ "name": "trainingSplitRatio",
25
+ "baseName": "trainingSplitRatio",
26
+ "type": "number"
27
+ },
28
+ {
29
+ "name": "testingSplitRatio",
30
+ "baseName": "testingSplitRatio",
31
+ "type": "number"
32
+ },
33
+ {
34
+ "name": "validationSplitRatio",
35
+ "baseName": "validationSplitRatio",
26
36
  "type": "number"
27
37
  },
28
38
  {
@@ -1 +1 @@
1
- {"version":3,"file":"datasetStratificationOptions.js","sourceRoot":"","sources":["../../../../library/sdk/model/datasetStratificationOptions.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAGH,MAAa,4BAA4B;IA0CrC,MAAM,CAAC,mBAAmB;QACtB,OAAO,4BAA4B,CAAC,gBAAgB,CAAC;IACzD,CAAC;;AA5CL,oEA6CC;AA3BU,0CAAa,GAAuB,SAAS,CAAC;AAE9C,6CAAgB,GAA0D;IAC7E;QACI,MAAM,EAAE,YAAY;QACpB,UAAU,EAAE,YAAY;QACxB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,iBAAiB;QACzB,UAAU,EAAE,iBAAiB;QAC7B,MAAM,EAAE,SAAS;KACpB;IACD;QACI,MAAM,EAAE,cAAc;QACtB,UAAU,EAAE,cAAc;QAC1B,MAAM,EAAE,eAAe;KAC1B;IACD;QACI,MAAM,EAAE,wBAAwB;QAChC,UAAU,EAAE,wBAAwB;QACpC,MAAM,EAAE,SAAS;KACpB;CAAK,CAAC"}
1
+ {"version":3,"file":"datasetStratificationOptions.js","sourceRoot":"","sources":["../../../../library/sdk/model/datasetStratificationOptions.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAGH,MAAa,4BAA4B;IA4DrC,MAAM,CAAC,mBAAmB;QACtB,OAAO,4BAA4B,CAAC,gBAAgB,CAAC;IACzD,CAAC;;AA9DL,oEA+DC;AArCU,0CAAa,GAAuB,SAAS,CAAC;AAE9C,6CAAgB,GAA0D;IAC7E;QACI,MAAM,EAAE,oBAAoB;QAC5B,UAAU,EAAE,oBAAoB;QAChC,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,mBAAmB;QAC3B,UAAU,EAAE,mBAAmB;QAC/B,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,sBAAsB;QAC9B,UAAU,EAAE,sBAAsB;QAClC,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,iBAAiB;QACzB,UAAU,EAAE,iBAAiB;QAC7B,MAAM,EAAE,SAAS;KACpB;IACD;QACI,MAAM,EAAE,cAAc;QACtB,UAAU,EAAE,cAAc;QAC1B,MAAM,EAAE,eAAe;KAC1B;IACD;QACI,MAAM,EAAE,wBAAwB;QAChC,UAAU,EAAE,wBAAwB;QACpC,MAAM,EAAE,SAAS;KACpB;CAAK,CAAC"}
@@ -27,5 +27,5 @@ export declare class GetDataExplorerFeaturesResponseAllOfSample {
27
27
  type: string;
28
28
  }[];
29
29
  }
30
- export type GetDataExplorerFeaturesResponseAllOfSampleCategoryEnum = 'training' | 'testing';
30
+ export type GetDataExplorerFeaturesResponseAllOfSampleCategoryEnum = 'training' | 'testing' | 'validation';
31
31
  export declare const GetDataExplorerFeaturesResponseAllOfSampleCategoryEnumValues: string[];
@@ -46,5 +46,5 @@ GetDataExplorerFeaturesResponseAllOfSample.attributeTypeMap = [
46
46
  "type": "GetDataExplorerFeaturesResponseAllOfSampleCategoryEnum"
47
47
  }
48
48
  ];
49
- exports.GetDataExplorerFeaturesResponseAllOfSampleCategoryEnumValues = ['training', 'testing'];
49
+ exports.GetDataExplorerFeaturesResponseAllOfSampleCategoryEnumValues = ['training', 'testing', 'validation'];
50
50
  //# sourceMappingURL=getDataExplorerFeaturesResponseAllOfSample.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"getDataExplorerFeaturesResponseAllOfSample.js","sourceRoot":"","sources":["../../../../library/sdk/model/getDataExplorerFeaturesResponseAllOfSample.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAGH,MAAa,0CAA0C;IAoCnD,MAAM,CAAC,mBAAmB;QACtB,OAAO,0CAA0C,CAAC,gBAAgB,CAAC;IACvE,CAAC;;AAtCL,gGAuCC;AAhCU,wDAAa,GAAuB,SAAS,CAAC;AAE9C,2DAAgB,GAA0D;IAC7E;QACI,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,MAAM;QACd,UAAU,EAAE,MAAM;QAClB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,SAAS;QACrB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,OAAO;QACf,UAAU,EAAE,OAAO;QACnB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,UAAU;QAClB,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,wDAAwD;KACnE;CAAK,CAAC;AASF,QAAA,4DAA4D,GAAa,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC"}
1
+ {"version":3,"file":"getDataExplorerFeaturesResponseAllOfSample.js","sourceRoot":"","sources":["../../../../library/sdk/model/getDataExplorerFeaturesResponseAllOfSample.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAGH,MAAa,0CAA0C;IAoCnD,MAAM,CAAC,mBAAmB;QACtB,OAAO,0CAA0C,CAAC,gBAAgB,CAAC;IACvE,CAAC;;AAtCL,gGAuCC;AAhCU,wDAAa,GAAuB,SAAS,CAAC;AAE9C,2DAAgB,GAA0D;IAC7E;QACI,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,MAAM;QACd,UAAU,EAAE,MAAM;QAClB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,SAAS;QACrB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,OAAO;QACf,UAAU,EAAE,OAAO;QACnB,MAAM,EAAE,QAAQ;KACnB;IACD;QACI,MAAM,EAAE,UAAU;QAClB,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,wDAAwD;KACnE;CAAK,CAAC;AASF,QAAA,4DAA4D,GAAa,CAAC,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC"}
@@ -13,6 +13,7 @@ import { ProjectDataSummary } from './projectDataSummary';
13
13
  export declare class ProjectInfoResponseAllOfDataSummaryPerCategory {
14
14
  'training': ProjectDataSummary;
15
15
  'testing': ProjectDataSummary;
16
+ 'validation': ProjectDataSummary;
16
17
  'postProcessing': ProjectDataSummary;
17
18
  static discriminator: string | undefined;
18
19
  static attributeTypeMap: Array<{
@@ -30,6 +30,11 @@ ProjectInfoResponseAllOfDataSummaryPerCategory.attributeTypeMap = [
30
30
  "baseName": "testing",
31
31
  "type": "ProjectDataSummary"
32
32
  },
33
+ {
34
+ "name": "validation",
35
+ "baseName": "validation",
36
+ "type": "ProjectDataSummary"
37
+ },
33
38
  {
34
39
  "name": "postProcessing",
35
40
  "baseName": "postProcessing",
@@ -1 +1 @@
1
- {"version":3,"file":"projectInfoResponseAllOfDataSummaryPerCategory.js","sourceRoot":"","sources":["../../../../library/sdk/model/projectInfoResponseAllOfDataSummaryPerCategory.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAIH,MAAa,8CAA8C;IAwBvD,MAAM,CAAC,mBAAmB;QACtB,OAAO,8CAA8C,CAAC,gBAAgB,CAAC;IAC3E,CAAC;;AA1BL,wGA2BC;AAtBU,4DAAa,GAAuB,SAAS,CAAC;AAE9C,+DAAgB,GAA0D;IAC7E;QACI,MAAM,EAAE,UAAU;QAClB,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,oBAAoB;KAC/B;IACD;QACI,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,SAAS;QACrB,MAAM,EAAE,oBAAoB;KAC/B;IACD;QACI,MAAM,EAAE,gBAAgB;QACxB,UAAU,EAAE,gBAAgB;QAC5B,MAAM,EAAE,oBAAoB;KAC/B;CAAK,CAAC"}
1
+ {"version":3,"file":"projectInfoResponseAllOfDataSummaryPerCategory.js","sourceRoot":"","sources":["../../../../library/sdk/model/projectInfoResponseAllOfDataSummaryPerCategory.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAIH,MAAa,8CAA8C;IA8BvD,MAAM,CAAC,mBAAmB;QACtB,OAAO,8CAA8C,CAAC,gBAAgB,CAAC;IAC3E,CAAC;;AAhCL,wGAiCC;AA3BU,4DAAa,GAAuB,SAAS,CAAC;AAE9C,+DAAgB,GAA0D;IAC7E;QACI,MAAM,EAAE,UAAU;QAClB,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,oBAAoB;KAC/B;IACD;QACI,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,SAAS;QACrB,MAAM,EAAE,oBAAoB;KAC/B;IACD;QACI,MAAM,EAAE,YAAY;QACpB,UAAU,EAAE,YAAY;QACxB,MAAM,EAAE,oBAAoB;KAC/B;IACD;QACI,MAAM,EAAE,gBAAgB;QACxB,UAAU,EAAE,gBAAgB;QAC5B,MAAM,EAAE,oBAAoB;KAC/B;CAAK,CAAC"}
@@ -9,5 +9,5 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- export type RawDataCategory = 'training' | 'testing' | 'post-processing';
12
+ export type RawDataCategory = 'training' | 'testing' | 'validation' | 'post-processing';
13
13
  export declare const RawDataCategoryValues: string[];
@@ -12,5 +12,5 @@
12
12
  */
13
13
  Object.defineProperty(exports, "__esModule", { value: true });
14
14
  exports.RawDataCategoryValues = void 0;
15
- exports.RawDataCategoryValues = ['training', 'testing', 'post-processing'];
15
+ exports.RawDataCategoryValues = ['training', 'testing', 'validation', 'post-processing'];
16
16
  //# sourceMappingURL=rawDataCategory.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"rawDataCategory.js","sourceRoot":"","sources":["../../../../library/sdk/model/rawDataCategory.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAKU,QAAA,qBAAqB,GAAa,CAAC,UAAU,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC"}
1
+ {"version":3,"file":"rawDataCategory.js","sourceRoot":"","sources":["../../../../library/sdk/model/rawDataCategory.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAKU,QAAA,qBAAqB,GAAa,CAAC,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC"}
@@ -9,5 +9,5 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- export type RawDataFilterCategory = 'training' | 'testing' | 'post-processing' | 'all';
12
+ export type RawDataFilterCategory = 'training' | 'testing' | 'validation' | 'post-processing' | 'all';
13
13
  export declare const RawDataFilterCategoryValues: string[];
@@ -12,5 +12,5 @@
12
12
  */
13
13
  Object.defineProperty(exports, "__esModule", { value: true });
14
14
  exports.RawDataFilterCategoryValues = void 0;
15
- exports.RawDataFilterCategoryValues = ['training', 'testing', 'post-processing', 'all'];
15
+ exports.RawDataFilterCategoryValues = ['training', 'testing', 'validation', 'post-processing', 'all'];
16
16
  //# sourceMappingURL=rawDataFilterCategory.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"rawDataFilterCategory.js","sourceRoot":"","sources":["../../../../library/sdk/model/rawDataFilterCategory.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAKU,QAAA,2BAA2B,GAAa,CAAC,UAAU,EAAE,SAAS,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAC"}
1
+ {"version":3,"file":"rawDataFilterCategory.js","sourceRoot":"","sources":["../../../../library/sdk/model/rawDataFilterCategory.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAKU,QAAA,2BAA2B,GAAa,CAAC,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edge-impulse-api",
3
- "version": "1.92.15",
3
+ "version": "1.92.16",
4
4
  "description": "Node.js bindings for the Edge Impulse API",
5
5
  "scripts": {
6
6
  "build": "tsc -p .",