Welcome to the Nucleus API Reference!

Aggregate metrics in ML are not good enough. To improve production ML, you need to understand qualitative failure modes, fix them by gathering more data, and curate diverse scenarios.

Scale Nucleus helps you:

• Visualize your data

• Curate interesting slices within your dataset

• Review and manage annotations

• Measure and debug your model performance

Nucleus is a new way—the right way—to develop ML models, helping us move away from the concept of one dataset and towards a paradigm of collections of scenarios.

Installation

To use Nucleus, first install it using pip:

(venv) $ pip install scale-nucleus

Sections

• nucleus
  • AsyncJob
    • AsyncJob.errors()
    • AsyncJob.from_id()
    • AsyncJob.sleep_until_complete()
    • AsyncJob.status()
  • BoxAnnotation
    • BoxAnnotation.from_json()
    • BoxAnnotation.has_local_files_to_upload()
    • BoxAnnotation.to_json()
    • BoxAnnotation.to_payload()
  • BoxPrediction
    • BoxPrediction.from_json()
    • BoxPrediction.has_local_files_to_upload()
    • BoxPrediction.to_json()
    • BoxPrediction.to_payload()
  • CameraParams
    • CameraParams.from_json()
    • CameraParams.to_payload()
  • CategoryAnnotation
    • CategoryAnnotation.from_json()
    • CategoryAnnotation.has_local_files_to_upload()
    • CategoryAnnotation.to_json()
    • CategoryAnnotation.to_payload()
  • CategoryPrediction
    • CategoryPrediction.from_json()
    • CategoryPrediction.has_local_files_to_upload()
    • CategoryPrediction.to_json()
    • CategoryPrediction.to_payload()
  • CuboidAnnotation
    • CuboidAnnotation.from_json()
    • CuboidAnnotation.has_local_files_to_upload()
    • CuboidAnnotation.to_json()
    • CuboidAnnotation.to_payload()
  • CuboidPrediction
    • CuboidPrediction.from_json()
    • CuboidPrediction.has_local_files_to_upload()
    • CuboidPrediction.to_json()
    • CuboidPrediction.to_payload()
  • Dataset
    • Dataset.add_items_from_dir()
    • Dataset.add_taxonomy()
    • Dataset.annotate()
    • Dataset.append()
    • Dataset.autotag_items()
    • Dataset.autotag_training_items()
    • Dataset.build_slice()
    • Dataset.calculate_evaluation_metrics()
    • Dataset.create_custom_index()
    • Dataset.create_image_index()
    • Dataset.create_object_index()
    • Dataset.create_slice()
    • Dataset.create_slice_by_ids()
    • Dataset.delete_annotations()
    • Dataset.delete_custom_index()
    • Dataset.delete_item()
    • Dataset.delete_scene()
    • Dataset.delete_taxonomy()
    • Dataset.delete_tracks()
    • Dataset.export_embeddings()
    • Dataset.export_predictions()
    • Dataset.export_scale_task_info()
    • Dataset.get_image_indexing_status()
    • Dataset.get_object_indexing_status()
    • Dataset.get_scene()
    • Dataset.get_scene_from_item_ref_id()
    • Dataset.get_slices()
    • Dataset.ground_truth_loc()
    • Dataset.iloc()
    • Dataset.info()
    • Dataset.ingest_tasks()
    • Dataset.items_and_annotation_chip_generator()
    • Dataset.items_and_annotation_generator()
    • Dataset.items_and_annotations()
    • Dataset.items_generator()
    • Dataset.jobs()
    • Dataset.list_autotags()
    • Dataset.loc()
    • Dataset.prediction_loc()
    • Dataset.predictions_iloc()
    • Dataset.predictions_refloc()
    • Dataset.query_items()
    • Dataset.query_objects()
    • Dataset.query_scenes()
    • Dataset.refloc()
    • Dataset.scene_and_annotation_generator()
    • Dataset.set_continuous_indexing()
    • Dataset.set_primary_index()
    • Dataset.update_autotag()
    • Dataset.update_item_metadata()
    • Dataset.update_scene_metadata()
    • Dataset.upload_lidar_semseg_predictions()
    • Dataset.upload_predictions()
  • DatasetInfo
    • DatasetInfo.dataset_id
    • DatasetInfo.name
    • DatasetInfo.length
    • DatasetInfo.model_run_ids
    • DatasetInfo.slice_ids
    • DatasetInfo.annotation_metadata_schema
    • DatasetInfo.item_metadata_schema
    • DatasetInfo.construct()
    • DatasetInfo.copy()
    • DatasetInfo.dict()
    • DatasetInfo.json()
    • DatasetInfo.model_construct()
    • DatasetInfo.model_copy()
    • DatasetInfo.model_dump()
    • DatasetInfo.model_dump_json()
    • DatasetInfo.model_json_schema()
    • DatasetInfo.model_parametrized_name()
    • DatasetInfo.model_post_init()
    • DatasetInfo.model_rebuild()
    • DatasetInfo.model_validate()
    • DatasetInfo.model_validate_json()
    • DatasetInfo.model_validate_strings()
    • DatasetInfo.update_forward_refs()
  • DatasetItem
    • DatasetItem.from_json()
    • DatasetItem.to_json()
    • DatasetItem.to_payload()
  • EmbeddingsExportJob
    • EmbeddingsExportJob.errors()
    • EmbeddingsExportJob.from_id()
    • EmbeddingsExportJob.result_urls()
    • EmbeddingsExportJob.sleep_until_complete()
    • EmbeddingsExportJob.status()
  • Frame
    • Frame.add_item()
    • Frame.from_json()
    • Frame.get_item()
    • Frame.get_items()
    • Frame.get_sensors()
    • Frame.to_payload()
  • Keypoint
  • KeypointsAnnotation
    • KeypointsAnnotation.from_json()
    • KeypointsAnnotation.has_local_files_to_upload()
    • KeypointsAnnotation.to_json()
    • KeypointsAnnotation.to_payload()
  • KeypointsPrediction
    • KeypointsPrediction.from_json()
    • KeypointsPrediction.has_local_files_to_upload()
    • KeypointsPrediction.to_json()
    • KeypointsPrediction.to_payload()
  • LidarPoint
  • LidarScene
    • LidarScene.add_frame()
    • LidarScene.add_item()
    • LidarScene.from_json()
    • LidarScene.get_frame()
    • LidarScene.get_frames()
    • LidarScene.get_item()
    • LidarScene.get_items()
    • LidarScene.get_items_from_sensor()
    • LidarScene.get_sensors()
    • LidarScene.info()
    • LidarScene.to_json()
    • LidarScene.to_payload()
  • LineAnnotation
    • LineAnnotation.from_json()
    • LineAnnotation.has_local_files_to_upload()
    • LineAnnotation.to_json()
    • LineAnnotation.to_payload()
  • LinePrediction
    • LinePrediction.from_json()
    • LinePrediction.has_local_files_to_upload()
    • LinePrediction.to_json()
    • LinePrediction.to_payload()
  • Model
    • Model.add_tags()
    • Model.add_trained_slice_ids()
    • Model.evaluate()
    • Model.from_json()
    • Model.remove_tags()
    • Model.remove_trained_slice_ids()
    • Model.run()
  • NucleusClient
    • NucleusClient.append_to_slice()
    • NucleusClient.create_dataset()
    • NucleusClient.create_dataset_from_dir()
    • NucleusClient.create_dataset_from_project()
    • NucleusClient.create_launch_model()
    • NucleusClient.create_launch_model_from_dir()
    • NucleusClient.create_model()
    • NucleusClient.delete_autotag()
    • NucleusClient.delete_dataset()
    • NucleusClient.delete_model()
    • NucleusClient.delete_slice()
    • NucleusClient.download_pointcloud_task()
    • NucleusClient.download_pointcloud_tasks()
    • NucleusClient.get_autotag_refinement_metrics()
    • NucleusClient.get_dataset()
    • NucleusClient.get_job()
    • NucleusClient.get_model()
    • NucleusClient.get_slice()
    • NucleusClient.list_jobs()
    • NucleusClient.make_request()
    • NucleusClient.valid_dirname()
  • Point
  • Point3D
  • PolygonAnnotation
    • PolygonAnnotation.from_json()
    • PolygonAnnotation.has_local_files_to_upload()
    • PolygonAnnotation.to_json()
    • PolygonAnnotation.to_payload()
  • PolygonPrediction
    • PolygonPrediction.from_json()
    • PolygonPrediction.has_local_files_to_upload()
    • PolygonPrediction.to_json()
    • PolygonPrediction.to_payload()
  • Quaternion
    • Quaternion.from_json()
    • Quaternion.to_payload()
  • SceneCategoryAnnotation
    • SceneCategoryAnnotation.from_json()
    • SceneCategoryAnnotation.has_local_files_to_upload()
    • SceneCategoryAnnotation.to_json()
    • SceneCategoryAnnotation.to_payload()
  • SceneCategoryPrediction
    • SceneCategoryPrediction.from_json()
    • SceneCategoryPrediction.has_local_files_to_upload()
    • SceneCategoryPrediction.to_json()
    • SceneCategoryPrediction.to_payload()
  • Segment
  • SegmentationAnnotation
    • SegmentationAnnotation.from_json()
    • SegmentationAnnotation.has_local_files_to_upload()
    • SegmentationAnnotation.to_json()
    • SegmentationAnnotation.to_payload()
  • SegmentationPrediction
    • SegmentationPrediction.from_json()
    • SegmentationPrediction.has_local_files_to_upload()
    • SegmentationPrediction.to_json()
    • SegmentationPrediction.to_payload()
  • Slice
    • Slice.add_tags()
    • Slice.append()
    • Slice.dataset_items()
    • Slice.export_embeddings()
    • Slice.export_predictions()
    • Slice.export_predictions_generator()
    • Slice.export_raw_items()
    • Slice.export_raw_json()
    • Slice.export_scale_task_info()
    • Slice.info()
    • Slice.items_and_annotation_generator()
    • Slice.items_and_annotations()
    • Slice.items_generator()
    • Slice.send_to_labeling()
  • VideoScene
    • VideoScene.add_item()
    • VideoScene.from_json()
    • VideoScene.get_item()
    • VideoScene.get_items()
    • VideoScene.info()
    • VideoScene.to_json()
    • VideoScene.to_payload()
• nucleus.validate
  • EvaluationCriterion
    • EvaluationCriterion.construct()
    • EvaluationCriterion.copy()
    • EvaluationCriterion.dict()
    • EvaluationCriterion.json()
    • EvaluationCriterion.model_construct()
    • EvaluationCriterion.model_copy()
    • EvaluationCriterion.model_dump()
    • EvaluationCriterion.model_dump_json()
    • EvaluationCriterion.model_json_schema()
    • EvaluationCriterion.model_parametrized_name()
    • EvaluationCriterion.model_post_init()
    • EvaluationCriterion.model_rebuild()
    • EvaluationCriterion.model_validate()
    • EvaluationCriterion.model_validate_json()
    • EvaluationCriterion.model_validate_strings()
    • EvaluationCriterion.update_forward_refs()
  • ScenarioTest
    • ScenarioTest.id
    • ScenarioTest.connection
    • ScenarioTest.name
    • ScenarioTest.slice_id
    • ScenarioTest.add_eval_function()
    • ScenarioTest.get_eval_functions()
    • ScenarioTest.get_eval_history()
    • ScenarioTest.get_items()
    • ScenarioTest.set_baseline_model()
  • Validate
    • Validate.create_external_eval_function()
    • Validate.create_scenario_test()
    • Validate.delete_scenario_test()
    • Validate.evaluate_model_on_scenario_tests()

Index

• Index