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
BoxAnnotation
BoxPrediction
CameraParams
CategoryAnnotation
CategoryPrediction
CuboidAnnotation
CuboidPrediction
Dataset
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_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.refloc()
Dataset.set_continuous_indexing()
Dataset.set_primary_index()
Dataset.update_autotag()
Dataset.update_item_metadata()
Dataset.update_scene_metadata()
Dataset.upload_predictions()
DatasetInfo
DatasetItem
EmbeddingsExportJob
Frame
Keypoint
KeypointsAnnotation
KeypointsPrediction
LidarPoint
LidarScene
LineAnnotation
LinePrediction
Model
NucleusClient
NucleusClient.append_to_slice()
NucleusClient.create_dataset()
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.get_autotag_refinement_metrics()
NucleusClient.get_dataset()
NucleusClient.get_job()
NucleusClient.get_model()
NucleusClient.get_slice()
NucleusClient.list_jobs()
NucleusClient.make_request()
Point
Point3D
PolygonAnnotation
PolygonPrediction
Quaternion
SceneCategoryAnnotation
SceneCategoryPrediction
Segment
SegmentationAnnotation
SegmentationPrediction
Slice
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
- nucleus.metrics
CategorizationF1
CuboidIOU
CuboidPrecision
CuboidRecall
FieldFilter
MetadataFilter
Metric
PolygonAveragePrecision
PolygonIOU
PolygonMAP
PolygonMetric
PolygonPrecision
PolygonRecall
ScalarResult
SegmentFieldFilter
SegmentMetadataFilter
SegmentationFWAVACC
SegmentationIOU
SegmentationMAP
SegmentationMaskMetric
SegmentationMaskToPolyMetric
SegmentationPrecision
SegmentationRecall
SegmentationToPolyAveragePrecision
SegmentationToPolyIOU
SegmentationToPolyMAP
SegmentationToPolyPrecision
SegmentationToPolyRecall
- nucleus.validate