@neuracore/types 6.13.0 → 7.1.0

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.
@@ -81,6 +81,30 @@ export interface BaseRecodingUpdatePayload {
81
81
  robot_id: string;
82
82
  instance: number;
83
83
  }
84
+ /**
85
+ * Request body for updating the status/progress of multiple data traces.
86
+ *
87
+ * Attributes:
88
+ * updates: A dictionary of trace_id -> TraceStatusUpdates
89
+ */
90
+ export interface BatchedUpdateTraceRequest {
91
+ updates: {
92
+ [k: string]: TraceStatusUpdates;
93
+ };
94
+ }
95
+ /**
96
+ * Represents an update status/progress of a data trace.
97
+ *
98
+ * Attributes:
99
+ * status: The status of the trace upload.
100
+ * uploaded_bytes: The number of bytes uploaded.
101
+ * total_bytes: The total number of bytes expected.
102
+ */
103
+ export interface TraceStatusUpdates {
104
+ status?: RecordingDataTraceStatus | null;
105
+ uploaded_bytes?: number | null;
106
+ total_bytes?: number | null;
107
+ }
84
108
  /**
85
109
  * Camera sensor data including images and calibration information.
86
110
  *
@@ -780,19 +804,25 @@ export interface DeploymentConfig {
780
804
  * training_id: Identifier of the trained model to deploy.
781
805
  * name: Optional name for the endpoint.
782
806
  * ttl: Optional time-to-live in seconds for the endpoint.
783
- * model_input_order: Specification of the model input data order.
784
- * model_output_order: Specification of the model output data order.
807
+ * input_embodiment_description: Specification of the model input data
808
+ * order.
809
+ * output_embodiment_description: Specification of the model output data
810
+ * order.
785
811
  * config: Deployment configuration parameters.
786
812
  */
787
813
  export interface DeploymentRequest {
788
814
  training_id: string;
789
815
  name?: string | null;
790
816
  ttl?: number | null;
791
- model_input_order: {
792
- [k: string]: string[];
817
+ input_embodiment_description: {
818
+ [k: string]: {
819
+ [k: string]: string;
820
+ };
793
821
  };
794
- model_output_order: {
795
- [k: string]: string[];
822
+ output_embodiment_description: {
823
+ [k: string]: {
824
+ [k: string]: string;
825
+ };
796
826
  };
797
827
  config?: DeploymentConfig;
798
828
  }
@@ -912,8 +942,10 @@ export interface HandshakeMessage {
912
942
  * algorithm_config: Configuration parameters for the algorithm.
913
943
  * gpu_type: The type of GPU to use for the job.
914
944
  * num_gpus: The number of GPUs to allocate for the job.
915
- * input_robot_data_spec: Mapping of robot to input data types to names
916
- * output_robot_data_spec: Mapping of robot to output data types to names
945
+ * input_cross_embodiment_description: Mapping of robot to input data
946
+ * types to names
947
+ * output_cross_embodiment_description: Mapping of robot to output data
948
+ * types to names
917
949
  */
918
950
  export interface InternalStartTrainingJobRequest {
919
951
  org_id: string;
@@ -928,14 +960,18 @@ export interface InternalStartTrainingJobRequest {
928
960
  gpu_type: GPUType;
929
961
  num_gpus: number;
930
962
  synchronization_details: SynchronizationDetails;
931
- input_robot_data_spec: {
963
+ input_cross_embodiment_description: {
932
964
  [k: string]: {
933
- [k: string]: string[];
965
+ [k: string]: {
966
+ [k: string]: string;
967
+ };
934
968
  };
935
969
  };
936
- output_robot_data_spec: {
970
+ output_cross_embodiment_description: {
937
971
  [k: string]: {
938
- [k: string]: string[];
972
+ [k: string]: {
973
+ [k: string]: string;
974
+ };
939
975
  };
940
976
  };
941
977
  }
@@ -944,7 +980,8 @@ export interface InternalStartTrainingJobRequest {
944
980
  *
945
981
  * Attributes:
946
982
  * frequency: Synchronization frequency in Hz.
947
- * robot_data_spec: Specification of robot data to include in the synchronization.
983
+ * cross_embodiment_description: Specification of robot data to include
984
+ * in the synchronization.
948
985
  * max_delay_s: Maximum allowable delay (in seconds) for synchronization.
949
986
  * allow_duplicates: Whether to allow duplicate data points in the synchronization.
950
987
  * trim_start_end: Whether to trim the start and end of the episode
@@ -952,7 +989,7 @@ export interface InternalStartTrainingJobRequest {
952
989
  */
953
990
  export interface SynchronizationDetails {
954
991
  frequency: number;
955
- robot_data_spec: {
992
+ cross_embodiment_union: {
956
993
  [k: string]: {
957
994
  [k: string]: string[];
958
995
  };
@@ -1032,9 +1069,11 @@ export interface MetricsData {
1032
1069
  * ModelInitDescription(
1033
1070
  * input_data_types=[DataType.RGB_IMAGES, DataType.JOINT_POSITIONS],
1034
1071
  * output_data_types=[DataType.JOINT_TARGET_POSITIONS],
1035
- * dataset_statistics={
1072
+ * input_dataset_statistics={
1036
1073
  * DataType.RGB_IMAGES: DataItemStats(...),
1037
1074
  * DataType.JOINT_POSITIONS: DataItemStats(...),
1075
+ * },
1076
+ * output_dataset_statistics={
1038
1077
  * DataType.JOINT_TARGET_POSITIONS: DataItemStats(...),
1039
1078
  * },
1040
1079
  * )
@@ -1042,7 +1081,10 @@ export interface MetricsData {
1042
1081
  export interface ModelInitDescription {
1043
1082
  input_data_types: DataType[];
1044
1083
  output_data_types: DataType[];
1045
- dataset_statistics: {
1084
+ input_dataset_statistics: {
1085
+ [k: string]: (JointDataStats | CameraDataStats | PoseDataStats | EndEffectorPoseDataStats | ParallelGripperOpenAmountDataStats | PointCloudDataStats | LanguageDataStats | Custom1DDataStats)[];
1086
+ };
1087
+ output_dataset_statistics: {
1046
1088
  [k: string]: (JointDataStats | CameraDataStats | PoseDataStats | EndEffectorPoseDataStats | ParallelGripperOpenAmountDataStats | PointCloudDataStats | LanguageDataStats | Custom1DDataStats)[];
1047
1089
  };
1048
1090
  output_prediction_horizon: number;
@@ -1287,7 +1329,7 @@ export interface RecordingDataTrace {
1287
1329
  id: string;
1288
1330
  recording_id: string;
1289
1331
  data_type: DataType;
1290
- status: RecordingDataTraceStatus;
1332
+ status: RecordingDataTraceStatus1;
1291
1333
  created_at: number;
1292
1334
  uploaded_at: number | null;
1293
1335
  uploaded_bytes: number;
@@ -1421,18 +1463,29 @@ export interface SynchronizedDataset {
1421
1463
  *
1422
1464
  * Attributes:
1423
1465
  * synchronized_dataset_id: Unique identifier for the synced dataset.
1424
- * robot_data_spec: Mapping of robot IDs to data type names.
1466
+ * cross_embodiment_description: Mapping of robot IDs to data type names.
1425
1467
  * dataset_statistics: Statistics for each robot and data type.
1426
1468
  */
1427
1469
  export interface SynchronizedDatasetStatistics {
1428
1470
  synchronized_dataset_id: string;
1429
- robot_data_spec: {
1471
+ input_cross_embodiment_description: {
1430
1472
  [k: string]: {
1431
- [k: string]: string[];
1473
+ [k: string]: {
1474
+ [k: string]: string;
1475
+ };
1476
+ };
1477
+ };
1478
+ output_cross_embodiment_description: {
1479
+ [k: string]: {
1480
+ [k: string]: {
1481
+ [k: string]: string;
1482
+ };
1432
1483
  };
1433
1484
  };
1434
1485
  dataset_statistics: {
1435
- [k: string]: (JointDataStats | CameraDataStats | PoseDataStats | EndEffectorPoseDataStats | ParallelGripperOpenAmountDataStats | PointCloudDataStats | LanguageDataStats | Custom1DDataStats)[];
1486
+ [k: string]: {
1487
+ [k: string]: (JointDataStats | CameraDataStats | PoseDataStats | EndEffectorPoseDataStats | ParallelGripperOpenAmountDataStats | PointCloudDataStats | LanguageDataStats | Custom1DDataStats)[];
1488
+ };
1436
1489
  };
1437
1490
  }
1438
1491
  /**
@@ -1496,8 +1549,8 @@ export interface TracesMetadataRequest {
1496
1549
  * previous_training_time: The time spent on the previous training, if applicable.
1497
1550
  * error: Any error message associated with the job, if applicable.
1498
1551
  * resume_points: List of timestamps where the job can be resumed.
1499
- * input_robot_data_spec: List of data types for the input data.
1500
- * output_robot_data_spec: List of data types for the output data.
1552
+ * input_cross_embodiment_description: List of data types for the input data.
1553
+ * output_cross_embodiment_description: List of data types for the output data.
1501
1554
  */
1502
1555
  export interface TrainingJob {
1503
1556
  id: string;
@@ -1523,14 +1576,18 @@ export interface TrainingJob {
1523
1576
  previous_training_time?: number | null;
1524
1577
  error?: string | null;
1525
1578
  resume_points: number[];
1526
- input_robot_data_spec: {
1579
+ input_cross_embodiment_description: {
1527
1580
  [k: string]: {
1528
- [k: string]: string[];
1581
+ [k: string]: {
1582
+ [k: string]: string;
1583
+ };
1529
1584
  };
1530
1585
  };
1531
- output_robot_data_spec: {
1586
+ output_cross_embodiment_description: {
1532
1587
  [k: string]: {
1533
- [k: string]: string[];
1588
+ [k: string]: {
1589
+ [k: string]: string;
1590
+ };
1534
1591
  };
1535
1592
  };
1536
1593
  synchronization_details: SynchronizationDetails;
@@ -1546,9 +1603,9 @@ export interface TrainingJob {
1546
1603
  * frequency: Synchronization frequency in Hz.
1547
1604
  * gpu_type: Type of GPU to use for training.
1548
1605
  * num_gpus: Number of GPUs to use for training.
1549
- * input_robot_data_spec: The robust mapping of robot to input
1606
+ * input_cross_embodiment_description: The robust mapping of robot to input
1550
1607
  * data types to names
1551
- * output_robot_data_spec: The robust mapping of robot to output
1608
+ * output_cross_embodiment_description: The robust mapping of robot to output
1552
1609
  * data types to names
1553
1610
  */
1554
1611
  export interface TrainingJobRequest {
@@ -1561,14 +1618,18 @@ export interface TrainingJobRequest {
1561
1618
  gpu_type: GPUType;
1562
1619
  num_gpus: number;
1563
1620
  synchronization_details: SynchronizationDetails;
1564
- input_robot_data_spec: {
1621
+ input_cross_embodiment_description: {
1565
1622
  [k: string]: {
1566
- [k: string]: string[];
1623
+ [k: string]: {
1624
+ [k: string]: string;
1625
+ };
1567
1626
  };
1568
1627
  };
1569
- output_robot_data_spec: {
1628
+ output_cross_embodiment_description: {
1570
1629
  [k: string]: {
1571
- [k: string]: string[];
1630
+ [k: string]: {
1631
+ [k: string]: string;
1632
+ };
1572
1633
  };
1573
1634
  };
1574
1635
  }
@@ -1594,6 +1655,14 @@ export declare enum DataType {
1594
1655
  LANGUAGE = "LANGUAGE",
1595
1656
  CUSTOM_1D = "CUSTOM_1D"
1596
1657
  }
1658
+ /**
1659
+ * Status for a recording data trace upload lifecycle.
1660
+ */
1661
+ export declare enum RecordingDataTraceStatus {
1662
+ QUEUED = "QUEUED",
1663
+ UPLOAD_STARTED = "UPLOAD_STARTED",
1664
+ UPLOAD_COMPLETE = "UPLOAD_COMPLETE"
1665
+ }
1597
1666
  export declare enum Type {
1598
1667
  CameraDataStats = "CameraDataStats"
1599
1668
  }
@@ -1879,7 +1948,7 @@ export declare enum Type16 {
1879
1948
  /**
1880
1949
  * Status for a recording data trace upload lifecycle.
1881
1950
  */
1882
- export declare enum RecordingDataTraceStatus {
1951
+ export declare enum RecordingDataTraceStatus1 {
1883
1952
  QUEUED = "QUEUED",
1884
1953
  UPLOAD_STARTED = "UPLOAD_STARTED",
1885
1954
  UPLOAD_COMPLETE = "UPLOAD_COMPLETE"
@@ -6,7 +6,7 @@
6
6
  /* Do not modify it by hand - just update the pydantic models and then re-run the script
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
- exports.GPUType2 = exports.TrainingJobStatus = exports.RecordingNotificationType = exports.RecordingDataTraceStatus = 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.AngleConfig1 = exports.EulerOrderConfig = exports.QuaternionOrderConfig = exports.RotationConfig = exports.PoseConfig = exports.DistanceUnitsConfig = exports.TorqueUnitsConfig = exports.AngleConfig = exports.ImageChannelOrderConfig = exports.ImageConventionConfig = exports.Type1 = exports.Type = exports.DataType = void 0;
9
+ 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.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;
10
10
  /**
11
11
  * Enumeration of supported data types in the Neuracore system.
12
12
  *
@@ -30,6 +30,15 @@ var DataType;
30
30
  DataType["LANGUAGE"] = "LANGUAGE";
31
31
  DataType["CUSTOM_1D"] = "CUSTOM_1D";
32
32
  })(DataType || (exports.DataType = DataType = {}));
33
+ /**
34
+ * Status for a recording data trace upload lifecycle.
35
+ */
36
+ var RecordingDataTraceStatus;
37
+ (function (RecordingDataTraceStatus) {
38
+ RecordingDataTraceStatus["QUEUED"] = "QUEUED";
39
+ RecordingDataTraceStatus["UPLOAD_STARTED"] = "UPLOAD_STARTED";
40
+ RecordingDataTraceStatus["UPLOAD_COMPLETE"] = "UPLOAD_COMPLETE";
41
+ })(RecordingDataTraceStatus || (exports.RecordingDataTraceStatus = RecordingDataTraceStatus = {}));
33
42
  var Type;
34
43
  (function (Type) {
35
44
  Type["CameraDataStats"] = "CameraDataStats";
@@ -358,12 +367,12 @@ var Type16;
358
367
  /**
359
368
  * Status for a recording data trace upload lifecycle.
360
369
  */
361
- var RecordingDataTraceStatus;
362
- (function (RecordingDataTraceStatus) {
363
- RecordingDataTraceStatus["QUEUED"] = "QUEUED";
364
- RecordingDataTraceStatus["UPLOAD_STARTED"] = "UPLOAD_STARTED";
365
- RecordingDataTraceStatus["UPLOAD_COMPLETE"] = "UPLOAD_COMPLETE";
366
- })(RecordingDataTraceStatus || (exports.RecordingDataTraceStatus = RecordingDataTraceStatus = {}));
370
+ var RecordingDataTraceStatus1;
371
+ (function (RecordingDataTraceStatus1) {
372
+ RecordingDataTraceStatus1["QUEUED"] = "QUEUED";
373
+ RecordingDataTraceStatus1["UPLOAD_STARTED"] = "UPLOAD_STARTED";
374
+ RecordingDataTraceStatus1["UPLOAD_COMPLETE"] = "UPLOAD_COMPLETE";
375
+ })(RecordingDataTraceStatus1 || (exports.RecordingDataTraceStatus1 = RecordingDataTraceStatus1 = {}));
367
376
  /**
368
377
  * Types of recording lifecycle notifications.
369
378
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@neuracore/types",
3
- "version": "6.13.0",
3
+ "version": "7.1.0",
4
4
  "description": "Shared TypeScript type definitions for Neuracore robotics platform",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",