@neuracore/types 10.5.0 → 10.6.0

package/README.md

@@ -25,6 +25,14 @@ yarn add @neuracore/types
 pnpm add @neuracore/types
 ```
 
+To track unreleased types from `main` (used by staging deploys and tests), install
+the `main` dist-tag instead. It is republished on every push to `main` that changes
+the generated types:
+
+```bash
+npm install @neuracore/types@main
+```
+
 ## Development
 
 ### Setup

package/dist/neuracore_types.d.ts

@@ -105,6 +105,33 @@ export interface TraceStatusUpdates {
     uploaded_bytes?: number | null;
     total_bytes?: number | null;
 }
+/**
+ * Request to start (or join) a dataset statistics calculation.
+ *
+ * Attributes:
+ *     synchronized_dataset_id: Synchronized dataset to compute statistics over.
+ *     input_cross_embodiment_description: Mapping of robot IDs to the canonical
+ *         index of each input data item.
+ *     output_cross_embodiment_description: Mapping of robot IDs to the canonical
+ *         index of each output data item.
+ */
+export interface CalculateDatasetStatisticsRequest {
+    synchronized_dataset_id: string;
+    input_cross_embodiment_description: {
+        [k: string]: {
+            [k: string]: {
+                [k: string]: string;
+            };
+        };
+    };
+    output_cross_embodiment_description: {
+        [k: string]: {
+            [k: string]: {
+                [k: string]: string;
+            };
+        };
+    };
+}
 /**
  * Camera sensor data including images and calibration information.
  *
@@ -850,6 +877,32 @@ export interface DatasetSplitRequest {
     description?: string | null;
     tags?: string[] | null;
 }
+/**
+ * State of an asynchronous dataset statistics calculation.
+ *
+ * Returned both when starting a job and when polling it, so a caller reads the
+ * total, the progress and the completion signal from one consistent snapshot.
+ *
+ * Attributes:
+ *     job_id: Identifier derived from the dataset, its recording set and both
+ *         cross-embodiment descriptions. Stable across repeat requests, and
+ *         different whenever any of those change.
+ *     synchronized_dataset_id: Synchronized dataset the job covers.
+ *     status: Current lifecycle stage.
+ *     num_recordings: Recordings the job must process.
+ *     num_completed_recordings: Recordings whose statistics are done. Reaching
+ *         num_recordings does not mean the result is fetchable: the aggregate
+ *         stage runs afterwards, so completion is read from ``status``.
+ *     error: Failure message when status is FAILED.
+ */
+export interface DatasetStatisticsJob {
+    job_id: string;
+    synchronized_dataset_id: string;
+    status: DatasetStatisticsJobStatus;
+    num_recordings: number;
+    num_completed_recordings: number;
+    error?: string | null;
+}
 /**
  * Request model for dataset updates.
  *
@@ -1597,8 +1650,12 @@ export interface SynchronizedDataset {
  *
  * Attributes:
  *     synchronized_dataset_id: Unique identifier for the synced dataset.
- *     cross_embodiment_description: Mapping of robot IDs to data type names.
- *     dataset_statistics: Statistics for each robot and data type.
+ *     input_cross_embodiment_description: Mapping of robot IDs to the canonical
+ *         index of each input data item.
+ *     output_cross_embodiment_description: Mapping of robot IDs to the canonical
+ *         index of each output data item.
+ *     dataset_statistics: Statistics for each robot and data type, keyed by
+ *         "input" and "output" and dense by canonical index.
  */
 export interface SynchronizedDatasetStatistics {
     synchronized_dataset_id: string;
@@ -1985,6 +2042,16 @@ export declare enum DatasetTypeConfig {
     LEROBOT = "LEROBOT",
     TFDS = "TFDS"
 }
+/**
+ * Lifecycle stage of an asynchronous dataset statistics calculation.
+ */
+export declare enum DatasetStatisticsJobStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    AGGREGATING = "AGGREGATING",
+    COMPLETE = "COMPLETE",
+    FAILED = "FAILED"
+}
 /**
  * GPU types available for training and deployment.
  */

package/dist/neuracore_types.js

@@ -6,7 +6,8 @@
 /* Do not modify it by hand - just update the pydantic models and then re-run the script
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GPUType2 = exports.TrainingJobStatus = exports.RecordingNotificationType = exports.RecordingDataTraceStatus1 = exports.Type16 = exports.Type15 = exports.Type14 = exports.PendingRecordingStatus = exports.RecordingStatus = exports.Type13 = exports.VideoFormat = exports.Type12 = exports.Type11 = exports.Type10 = exports.Type9 = exports.Type8 = exports.Type7 = exports.Type6 = exports.MessageType = exports.GPUType1 = exports.EndpointStatus = exports.Type5 = exports.Type4 = exports.Type3 = exports.GPUType = exports.DatasetTypeConfig = exports.Type2 = exports.IntrinsicsConfig = exports.PoseConfig1 = exports.ActionSpaceConfig = exports.ActionTypeConfig = exports.JointPositionInputTypeConfig = exports.VisualJointInputTypeConfig = exports.LanguageConfig = exports.EndEffectorPoseInputTypeConfig = exports.Frame = exports.AngleConfig1 = exports.EulerOrderConfig = exports.QuaternionOrderConfig = exports.RotationConfig = exports.PoseConfig = exports.DistanceUnitsConfig = exports.TorqueUnitsConfig = exports.AngleConfig = exports.ImageChannelOrderConfig = exports.ImageConventionConfig = exports.Type1 = exports.Type = exports.RecordingDataTraceStatus = exports.DataType = void 0;
+exports.TrainingJobStatus = exports.RecordingNotificationType = exports.RecordingDataTraceStatus1 = exports.Type16 = exports.Type15 = exports.Type14 = exports.PendingRecordingStatus = exports.RecordingStatus = exports.Type13 = exports.VideoFormat = exports.Type12 = exports.Type11 = exports.Type10 = exports.Type9 = exports.Type8 = exports.Type7 = exports.Type6 = exports.MessageType = exports.GPUType1 = exports.EndpointStatus = exports.Type5 = exports.Type4 = exports.Type3 = exports.GPUType = exports.DatasetStatisticsJobStatus = exports.DatasetTypeConfig = exports.Type2 = exports.IntrinsicsConfig = exports.PoseConfig1 = exports.ActionSpaceConfig = exports.ActionTypeConfig = exports.JointPositionInputTypeConfig = exports.VisualJointInputTypeConfig = exports.LanguageConfig = exports.EndEffectorPoseInputTypeConfig = exports.Frame = exports.AngleConfig1 = exports.EulerOrderConfig = exports.QuaternionOrderConfig = exports.RotationConfig = exports.PoseConfig = exports.DistanceUnitsConfig = exports.TorqueUnitsConfig = exports.AngleConfig = exports.ImageChannelOrderConfig = exports.ImageConventionConfig = exports.Type1 = exports.Type = exports.RecordingDataTraceStatus = exports.DataType = void 0;
+exports.GPUType2 = void 0;
 /**
  * Enumeration of supported data types in the Neuracore system.
  *
@@ -248,6 +249,17 @@ var DatasetTypeConfig;
     DatasetTypeConfig["LEROBOT"] = "LEROBOT";
     DatasetTypeConfig["TFDS"] = "TFDS";
 })(DatasetTypeConfig || (exports.DatasetTypeConfig = DatasetTypeConfig = {}));
+/**
+ * Lifecycle stage of an asynchronous dataset statistics calculation.
+ */
+var DatasetStatisticsJobStatus;
+(function (DatasetStatisticsJobStatus) {
+    DatasetStatisticsJobStatus["PENDING"] = "PENDING";
+    DatasetStatisticsJobStatus["RUNNING"] = "RUNNING";
+    DatasetStatisticsJobStatus["AGGREGATING"] = "AGGREGATING";
+    DatasetStatisticsJobStatus["COMPLETE"] = "COMPLETE";
+    DatasetStatisticsJobStatus["FAILED"] = "FAILED";
+})(DatasetStatisticsJobStatus || (exports.DatasetStatisticsJobStatus = DatasetStatisticsJobStatus = {}));
 /**
  * GPU types available for training and deployment.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuracore/types",
-  "version": "10.5.0",
+  "version": "10.6.0",
   "description": "Shared TypeScript type definitions for Neuracore robotics platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",