Logo

Table of Contents

  • Command Line Interface
    • Positional Arguments
    • Named Arguments
    • Sub-commands:
      • shell
      • upgrade
        • optional named arguments
      • logout
      • login
      • login-token
        • required named arguments
      • login-secret
        • required named arguments
      • login-m2m
        • required named arguments
      • init
      • checkout-state
      • help
      • version
      • api
        • Positional Arguments
        • Sub-commands:
      • development
        • Positional Arguments
        • Sub-commands:
      • projects
        • Positional Arguments
        • Sub-commands:
      • datasets
        • Positional Arguments
        • Sub-commands:
      • items
        • Positional Arguments
        • Sub-commands:
      • videos
        • Positional Arguments
        • Sub-commands:
      • app
        • Positional Arguments
        • Sub-commands:
      • services
        • Positional Arguments
        • Sub-commands:
      • triggers
        • Positional Arguments
        • Sub-commands:
      • deploy
        • required named arguments
      • generate
        • optional named arguments
      • packages
        • Positional Arguments
        • Sub-commands:
      • ls
      • pwd
      • cd
        • Positional Arguments
      • mkdir
        • Positional Arguments
      • clear
      • exit
  • Repositories
    • Organizations
      • Organizations
        • Organizations.add_member()
        • Organizations.cache_action()
        • Organizations.delete_member()
        • Organizations.get()
        • Organizations.list()
        • Organizations.list_groups()
        • Organizations.list_integrations()
        • Organizations.list_members()
        • Organizations.update()
        • Organizations.update_member()
      • Integrations
        • Integrations
    • Projects
      • Projects
        • Projects.add_member()
        • Projects.checkout()
        • Projects.create()
        • Projects.delete()
        • Projects.get()
        • Projects.list()
        • Projects.list_members()
        • Projects.open_in_web()
        • Projects.remove_member()
        • Projects.update()
        • Projects.update_member()
    • Datasets
      • Datasets
        • Datasets.bulk_update_ml_subset()
        • Datasets.checkout()
        • Datasets.clone()
        • Datasets.create()
        • Datasets.delete()
        • Datasets.directory_tree()
        • Datasets.download_annotations()
        • Datasets.export()
        • Datasets.get()
        • Datasets.list()
        • Datasets.merge()
        • Datasets.open_in_web()
        • Datasets.set_readonly()
        • Datasets.split_ml_subsets()
        • Datasets.sync()
        • Datasets.unlock()
        • Datasets.update()
        • Datasets.upload_annotations()
      • Drivers
        • Drivers
    • Items
      • Items
        • Items.clone()
        • Items.delete()
        • Items.download()
        • Items.get()
        • Items.get_all_items()
        • Items.list()
        • Items.make_dir()
        • Items.move_items()
        • Items.open_in_web()
        • Items.set_items_entity()
        • Items.task_scores()
        • Items.update()
        • Items.update_status()
        • Items.upload()
    • Annotations
      • Annotations
        • Annotations.builder()
        • Annotations.delete()
        • Annotations.download()
        • Annotations.get()
        • Annotations.list()
        • Annotations.show()
        • Annotations.task_scores()
        • Annotations.update()
        • Annotations.update_status()
        • Annotations.upload()
    • Recipes
      • Recipes
        • Recipes.clone()
        • Recipes.create()
        • Recipes.delete()
        • Recipes.get()
        • Recipes.list()
        • Recipes.open_in_web()
        • Recipes.update()
      • Ontologies
        • Ontologies
    • Tasks
      • Tasks
        • Tasks.add_items()
        • Tasks.create()
        • Tasks.create_consensus_task()
        • Tasks.create_honeypot_task()
        • Tasks.create_labeling_task()
        • Tasks.create_qa_task()
        • Tasks.create_qualification_task()
        • Tasks.delete()
        • Tasks.get()
        • Tasks.get_items()
        • Tasks.list()
        • Tasks.open_in_web()
        • Tasks.query()
        • Tasks.remove_items()
        • Tasks.set_status()
        • Tasks.task_scores()
        • Tasks.update()
      • Assignments
        • Assignments
    • Packages
      • LocalServiceRunner
        • LocalServiceRunner.get_field()
        • LocalServiceRunner.get_mainpy_run_service()
        • LocalServiceRunner.run_local_project()
      • Packages
        • Packages.build()
        • Packages.build_requirements()
        • Packages.build_trigger_dict()
        • Packages.check_cls_arguments()
        • Packages.checkout()
        • Packages.delete()
        • Packages.deploy()
        • Packages.deploy_from_file()
        • Packages.generate()
        • Packages.get()
        • Packages.list()
        • Packages.open_in_web()
        • Packages.pull()
        • Packages.push()
        • Packages.revisions()
        • Packages.test_local_package()
        • Packages.update()
      • Codebases
        • Codebases
    • Services
      • ServiceLog
        • ServiceLog.view()
      • Services
        • Services.activate_slots()
        • Services.checkout()
        • Services.delete()
        • Services.deploy()
        • Services.deploy_from_local_folder()
        • Services.execute()
        • Services.get()
        • Services.list()
        • Services.log()
        • Services.name_validation()
        • Services.open_in_web()
        • Services.pause()
        • Services.restart()
        • Services.resume()
        • Services.revisions()
        • Services.status()
        • Services.update()
      • Bots
        • Bots
    • Triggers
      • Triggers
        • Triggers.create()
        • Triggers.delete()
        • Triggers.get()
        • Triggers.list()
        • Triggers.name_validation()
        • Triggers.resource_information()
        • Triggers.update()
    • Executions
      • Executions
        • Executions.create()
        • Executions.create_batch()
        • Executions.get()
        • Executions.increment()
        • Executions.list()
        • Executions.logs()
        • Executions.progress_update()
        • Executions.rerun()
        • Executions.rerun_batch()
        • Executions.terminate()
        • Executions.update()
        • Executions.wait()
    • Models
      • Models
        • Models.add_subset()
        • Models.clone()
        • Models.create()
        • Models.delete()
        • Models.delete_subset()
        • Models.deploy()
        • Models.embed()
        • Models.embed_datasets()
        • Models.evaluate()
        • Models.get()
        • Models.list()
        • Models.open_in_web()
        • Models.predict()
        • Models.train()
        • Models.update()
        • Models.wait_for_model_ready()
    • Pipelines
      • Pipelines
        • Pipelines.create()
        • Pipelines.delete()
        • Pipelines.execute()
        • Pipelines.get()
        • Pipelines.install()
        • Pipelines.list()
        • Pipelines.open_in_web()
        • Pipelines.pause()
        • Pipelines.reset()
        • Pipelines.stats()
        • Pipelines.test()
        • Pipelines.update()
        • Pipelines.update_settings()
        • Pipelines.validate()
      • Pipeline Executions
        • PipelineExecutions
    • General Commands
      • Commands
        • Commands.abort()
        • Commands.get()
        • Commands.list()
        • Commands.wait()
      • Download Commands
      • Upload Commands
  • Entities
    • Organization
      • CacheAction
      • MemberOrgRole
      • Organization
        • Organization.add_member()
        • Organization.cache_action()
        • Organization.delete_member()
        • Organization.from_json()
        • Organization.list_groups()
        • Organization.list_members()
        • Organization.open_in_web()
        • Organization.to_json()
        • Organization.update()
        • Organization.update_member()
      • OrganizationsPlans
      • PodType
      • Integration
        • Integration
        • IntegrationType
    • Project
      • MemberRole
      • Project
        • Project.add_member()
        • Project.checkout()
        • Project.delete()
        • Project.from_json()
        • Project.list_members()
        • Project.open_in_web()
        • Project.remove_member()
        • Project.to_json()
        • Project.update()
        • Project.update_member()
      • User
        • User
    • Dataset
      • Dataset
        • Dataset.add_label()
        • Dataset.add_labels()
        • Dataset.assign_subset_to_items()
        • Dataset.checkout()
        • Dataset.clone()
        • Dataset.delete()
        • Dataset.delete_attributes()
        • Dataset.delete_labels()
        • Dataset.download()
        • Dataset.download_annotations()
        • Dataset.download_folder()
        • Dataset.export()
        • Dataset.from_json()
        • Dataset.get_items_missing_ml_subset()
        • Dataset.get_recipe_ids()
        • Dataset.open_in_web()
        • Dataset.remove_subset_from_items()
        • Dataset.serialize_labels()
        • Dataset.set_readonly()
        • Dataset.split_ml_subsets()
        • Dataset.switch_recipe()
        • Dataset.sync()
        • Dataset.to_json()
        • Dataset.unlock()
        • Dataset.update()
        • Dataset.update_attributes()
        • Dataset.update_label()
        • Dataset.update_labels()
        • Dataset.upload_annotations()
      • ExpirationOptions
      • ExportType
      • IndexDriver
      • OutputExportType
      • Driver
        • AzureBlobDriver
        • Driver
        • ExternalStorage
        • GcsDriver
        • S3Driver
    • Item
      • ExportMetadata
      • Item
        • Item.assign_collection()
        • Item.assign_subset()
        • Item.clone()
        • Item.delete()
        • Item.download()
        • Item.from_json()
        • Item.get_current_subset()
        • Item.list_collections()
        • Item.move()
        • Item.open_in_web()
        • Item.remove_subset()
        • Item.set_description()
        • Item.status()
        • Item.task_scores()
        • Item.to_json()
        • Item.unassign_collection()
        • Item.update()
        • Item.update_status()
      • ItemStatus
      • ModalityRefTypeEnum
      • ModalityTypeEnum
      • Item Link
        • LinkTypeEnum
    • Annotation
      • Annotation
        • Annotation.add_frame()
        • Annotation.add_frames()
        • Annotation.delete()
        • Annotation.download()
        • Annotation.from_json()
        • Annotation.new()
        • Annotation.set_frame()
        • Annotation.show()
        • Annotation.task_scores()
        • Annotation.to_json()
        • Annotation.update()
        • Annotation.update_status()
        • Annotation.upload()
      • AnnotationStatus
      • AnnotationType
      • ExportVersion
      • FrameAnnotation
        • FrameAnnotation.from_snapshot()
        • FrameAnnotation.new()
        • FrameAnnotation.show()
      • ViewAnnotationOptions
      • Collection of Annotation entities
        • AnnotationCollection
      • Annotation Definition
        • Box Annotation Definition
        • Classification Annotation Definition
        • Cuboid Annotation Definition
        • Item Description Definition
        • Ellipse Annotation Definition
        • Note Annotation Definition
        • Point Annotation Definition
        • Polygon Annotation Definition
        • Polyline Annotation Definition
        • Pose Annotation Definition
        • Segmentation Annotation Definition
        • Audio Annotation Definition
        • Undefined Annotation Definition
      • Similarity
    • Filter
      • Filters
        • Filters.add()
        • Filters.add_join()
        • Filters.generate_url_query_params()
        • Filters.has_field()
        • Filters.list()
        • Filters.load()
        • Filters.open_in_web()
        • Filters.platform_url()
        • Filters.pop()
        • Filters.pop_join()
        • Filters.prepare()
        • Filters.save()
        • Filters.sort_by()
      • FiltersKnownFields
      • FiltersMethod
      • FiltersOperations
      • FiltersOrderByDirection
      • FiltersResource
    • Recipe
      • Recipe
        • Recipe.add_instruction()
        • Recipe.clone()
        • Recipe.delete()
        • Recipe.from_json()
        • Recipe.get_annotation_template_id()
        • Recipe.open_in_web()
        • Recipe.to_json()
        • Recipe.update()
        • Recipe.upload_annotations_verification_file()
      • Ontology
        • Ontology
        • Label
    • Task
      • AllocationMethod
      • ConsensusTaskType
      • Task
        • Task.add_items()
        • Task.create_assignment()
        • Task.create_qa_task()
        • Task.delete()
        • Task.from_json()
        • Task.get_items()
        • Task.open_in_web()
        • Task.remove_items()
        • Task.set_status()
        • Task.to_json()
        • Task.update()
      • TaskPriority
      • Assignment
        • Assignment
        • Workload
        • WorkloadUnit
    • Package
      • Package
        • Package.build()
        • Package.checkout()
        • Package.delete()
        • Package.deploy()
        • Package.from_json()
        • Package.get_ml_metadata()
        • Package.open_in_web()
        • Package.pull()
        • Package.push()
        • Package.test()
        • Package.to_json()
        • Package.update()
      • RequirementOperator
      • Package Function
        • PackageFunction
        • PackageInputType
      • Package Module
        • PackageModule
      • Slot
        • PackageSlot
        • SlotDisplayScopeResource
        • SlotPostActionType
        • UiBindingPanel
      • Codebase
        • Codebase()
    • Service
      • DynamicConcurrencyUpdateMethod
      • InstanceCatalog
      • KubernetesAutoscalerType
      • OnResetAction
      • RuntimeType
      • Service
        • Service.activate_slots()
        • Service.checkout()
        • Service.delete()
        • Service.execute()
        • Service.execute_batch()
        • Service.from_json()
        • Service.log()
        • Service.open_in_web()
        • Service.pause()
        • Service.rerun_batch()
        • Service.restart()
        • Service.resume()
        • Service.status()
        • Service.to_json()
        • Service.update()
      • ServiceModeType
      • ServiceType
      • Bot
        • Bot
    • Trigger
      • BaseTrigger
        • BaseTrigger.delete()
        • BaseTrigger.from_json()
        • BaseTrigger.to_json()
        • BaseTrigger.update()
      • CronTrigger
        • CronTrigger.from_json()
        • CronTrigger.to_json()
      • Trigger
        • Trigger.from_json()
        • Trigger.to_json()
      • TriggerAction
      • TriggerExecutionMode
      • TriggerResource
      • TriggerType
    • Execution
      • Execution
        • Execution.from_json()
        • Execution.increment()
        • Execution.logs()
        • Execution.progress_update()
        • Execution.rerun()
        • Execution.terminate()
        • Execution.to_json()
        • Execution.update()
        • Execution.wait()
      • ExecutionStatus
    • Model
      • DatasetSubsetType
      • Model
        • Model.add_subset()
        • Model.clone()
        • Model.delete()
        • Model.delete_subset()
        • Model.deploy()
        • Model.embed()
        • Model.embed_datasets()
        • Model.evaluate()
        • Model.from_json()
        • Model.log()
        • Model.open_in_web()
        • Model.predict()
        • Model.to_json()
        • Model.train()
        • Model.update()
        • Model.wait_for_model_ready()
      • ModelStatus
    • Pipeline
      • CompositionStatus
      • Pipeline
        • Pipeline.delete()
        • Pipeline.execute()
        • Pipeline.execute_batch()
        • Pipeline.from_json()
        • Pipeline.install()
        • Pipeline.open_in_web()
        • Pipeline.pause()
        • Pipeline.reset()
        • Pipeline.set_start_node()
        • Pipeline.stats()
        • Pipeline.test()
        • Pipeline.to_json()
        • Pipeline.update()
        • Pipeline.update_variables_values()
        • Pipeline.validate()
      • PipelineResumeOption
      • Variable
        • Variable.from_json()
        • Variable.to_json()
      • Pipeline Execution
        • CycleRerunMethod
        • PipelineExecution
        • PipelineExecutionStatus
    • Other
      • Pages
        • PagedEntities
      • Base Entity
        • DlList
        • EntityScopeLevel
      • Command
        • Command
        • CommandsStatus
      • Directory Tree
        • DirectoryTree
        • SingleDirectory
  • Utilities
    • converter
      • Converter
        • Converter.attach_agent_progress()
        • Converter.convert()
        • Converter.convert_dataset()
        • Converter.convert_directory()
        • Converter.convert_file()
        • Converter.custom_format()
        • Converter.from_coco()
        • Converter.from_voc()
        • Converter.from_yolo()
        • Converter.save_to_file()
        • Converter.to_coco()
        • Converter.to_voc()
        • Converter.to_yolo()
        • Converter.upload_local_dataset()
dtlpy
  • »
  • Search

© Copyright 2025, Dataloop Team.

Built with Sphinx using a theme provided by Read the Docs.