Logo
v1.65.24

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:
      • projects
        • Positional Arguments
        • Sub-commands:
      • datasets
        • Positional Arguments
        • Sub-commands:
      • items
        • Positional Arguments
        • Sub-commands:
      • videos
        • 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.checkout()
        • Datasets.clone()
        • Datasets.create()
        • Datasets.delete()
        • Datasets.directory_tree()
        • Datasets.download_annotations()
        • Datasets.get()
        • Datasets.list()
        • Datasets.merge()
        • Datasets.open_in_web()
        • Datasets.set_readonly()
        • Datasets.sync()
        • 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.update()
        • Items.update_status()
        • Items.upload()
    • Annotations
      • Annotations
        • Annotations.builder()
        • Annotations.delete()
        • Annotations.download()
        • Annotations.get()
        • Annotations.list()
        • Annotations.show()
        • 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_qa_task()
        • Tasks.delete()
        • Tasks.get()
        • Tasks.get_items()
        • Tasks.list()
        • Tasks.open_in_web()
        • Tasks.query()
        • Tasks.remove_items()
        • Tasks.set_status()
        • 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.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.get()
        • Executions.increment()
        • Executions.list()
        • Executions.logs()
        • Executions.progress_update()
        • Executions.rerun()
        • Executions.terminate()
        • Executions.update()
        • Executions.wait()
    • 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.update()
      • 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
    • 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.checkout()
        • Dataset.clone()
        • Dataset.delete()
        • Dataset.delete_attributes()
        • Dataset.delete_labels()
        • Dataset.download()
        • Dataset.download_annotations()
        • Dataset.from_json()
        • Dataset.get_recipe_ids()
        • Dataset.open_in_web()
        • Dataset.serialize_labels()
        • Dataset.set_readonly()
        • Dataset.switch_recipe()
        • Dataset.sync()
        • Dataset.to_json()
        • Dataset.update()
        • Dataset.update_attributes()
        • Dataset.update_label()
        • Dataset.update_labels()
        • Dataset.upload_annotations()
      • ExpirationOptions
      • IndexDriver
      • Driver
        • Driver
        • ExternalStorage
    • Item
      • ExportMetadata
      • Item
        • Item.clone()
        • Item.delete()
        • Item.download()
        • Item.from_json()
        • Item.move()
        • Item.open_in_web()
        • Item.set_description()
        • Item.to_json()
        • 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.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
        • Collection
        • CollectionItem
        • CollectionTypes
        • MultiView
        • MultiViewItem
        • Similarity
        • SimilarityItem
        • SimilarityTypeEnum
    • Filter
      • Filters
        • Filters.add()
        • Filters.add_join()
        • Filters.generate_url_query_params()
        • Filters.has_field()
        • Filters.open_in_web()
        • Filters.platform_url()
        • Filters.pop()
        • Filters.pop_join()
        • Filters.prepare()
        • 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()
      • Ontology
        • Ontology
        • Label
    • Task
      • Task
        • Task.add_items()
        • Task.create_assignment()
        • Task.create_qa_task()
        • Task.delete()
        • 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.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
    • Service
      • InstanceCatalog
      • KubernetesAutuscalerType
      • OnResetAction
      • RuntimeType
      • Service
        • Service.activate_slots()
        • Service.checkout()
        • Service.delete()
        • Service.execute()
        • Service.from_json()
        • Service.log()
        • Service.open_in_web()
        • Service.pause()
        • Service.resume()
        • Service.status()
        • Service.to_json()
        • Service.update()
      • 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
    • Pipeline
      • Pipeline
        • Pipeline.delete()
        • Pipeline.execute()
        • Pipeline.from_json()
        • Pipeline.install()
        • Pipeline.open_in_web()
        • Pipeline.pause()
        • Pipeline.reset()
        • Pipeline.set_start_node()
        • Pipeline.stats()
        • Pipeline.to_json()
        • Pipeline.update()
      • Pipeline Execution
        • PipelineExecution
    • Other
      • Pages
        • PagedEntities
      • Base Entity
        • 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()
  • Tutorials
    • Getting Started With Dataloop SDK
      • 1. Overview
        • 1.1. About Dataloop
        • 1.2. Data Management
        • 1.3. Recipe & Ontology
        • 1.4. Annotation @ QA Workflow
        • 1.5. Annotations - Upload & Download (Export)
        • 1.6. Automation - Services (FaaS)
        • 1.7. Automation - Pipelines
      • 2. Working with Dataloop SDK
      • 3. Getting Started
        • 3.1. Installations and environment creation:
        • 3.2. Login
        • 3.3. M2M Login
        • 3.4. Log In Via SDK with M2M :
        • 3.5. Create & Get a Project
        • 3.6. Create & Get a Dataset
        • 3.7. Upload items
        • 3.8. Get Item / items-list
        • 3.9. Filters includes join and all operations
        • 3.10. Add metadata to the item
        • 3.11. Upload annotations (with Dataloop Builder)
        • 3.12. Upload segmentation annotation
        • 3.13. Get annotations + list (pages)
        • 3.14. Annotation update includes metadata
        • 3.15. load annotations from JSON file
        • 3.16. Creating an annotation task and adding items to it
    • Data Management Tutorial
      • 1. Cloud Storage
        • 1.1. External Storage Dataset
        • 1.2. Create an AWS Lambda to Continuously Sync a Bucket with Dataloop’s Dataset
      • 2. Manage Datasets
        • 2.1. Create Dataset
        • 2.2. Create Dataset With Cloud Storage Driver
        • 2.3. Retrieve Datasets
        • 2.4. Create Directory
        • 2.5. Deep Copy a Folder to Another Dataset
      • 3. Data Versioning
        • 3.1. Clone Datasets
        • 3.2. Merge Datasets
      • 4. Upload & Manage Data & Metadata
        • 4.1. Upload Specific Files
        • 4.2. Upload All Files in a Folder
        • 4.3. Upload Items From URL Links
        • 4.4. Upload Items with Metadata
      • 5. Upload & Manage Annotations
        • 5.1. Upload User Metadata
        • 5.2. Convert Annotations To COCO Format
        • 5.3. Upload Entire Directory and their Corresponding Dataloop JSON Annotations
        • 5.4. Upload Annotations To Video Item
        • 5.5. Upload Annotations In VTT Format
        • 5.6. Upload Audio Annotation to an Audio File
        • 5.7. Set Attributes On Annotations
        • 5.8. Free Text Attribute
        • 5.9. Range Attributes (Slider in UI)
        • 5.10. CheckBox Attribute (Multiple choice)
        • 5.11. Radio Button Attribute (Single Choice)
        • 5.12. Yes/No Attribute
        • 5.13. Show Annotations Over Image
        • 5.14. Download Data, Annotations & Metadata
        • 5.15. Download Items and Annotations
        • 5.16. Filter by Item and/or Annotation
        • 5.17. Filter by Annotations
        • 5.18. Download Annotations in COCO/YOLO/VOC Format
      • 6. Advance SDK Filters
        • 6.1. Filter Operators
        • 6.2. SDK defaults
        • 6.3. Delete a Filter
        • 6.4. Full Examples
      • 7. The Dataloop Query Language - DQL
        • 7.1. Filters
        • 7.2. Filter Annotations
        • 7.3. Filter Annotations by the Annotations’ Item
        • 7.4. Filters Method - “Or” and “And”
        • 7.5. Delete Filtered Items
        • 7.6. Annotation Filtering Fields
        • 7.7. Full Examples
        • 7.8. Advanced Filtering Operators
      • 8. The Dataloop Query Language - DQL
        • 8.1. Filters
        • 8.2. Filter Items
        • 8.3. Filter Items by the Items’ Annotations
        • 8.4. Filters Method - “Or” and “And”
        • 8.5. Update User Metadata of Filtered Items
        • 8.6. Delete Filtered Items
        • 8.7. Item Filtering Fields
        • 8.8. Full Examples
        • 8.9. Advanced Filtering Operators
        • 8.10. Response to DQL Query
      • 9. Pagination
        • 9.1. Pages
        • 9.2. Iterator of Items
        • 9.3. Set page_size
      • 10. Working with Metadata
        • 10.1. User Metadata
    • FaaS Tutorial
      • 1. FaaS Interactive Tutorial
        • 1.1. Concept
        • 1.2. Use Cases
      • 2. Introduction
      • 3. Basic Use Case: Single Function
        • 3.1. Create and Deploy a Sample Function
        • 3.2. Execute the function
      • 4. Multiple Functions and Modules
        • 4.1. Multiple Functions
        • 4.2. Multiple Modules
      • 5. Executions Control
        • 5.1. Execution Termination
        • 5.2. Execution Timeout
      • 6. UI Slots
        • 6.1. Define a UI slot in the platform
        • 6.2. Update the Package and Service with the Slot
        • 6.3. Activate the UI slot
      • 7. FaaS Docker Image
        • 7.1. Our Docker Image
        • 7.2. Public Docker Images
        • 7.3. Build Your Own Docker Image
        • 7.4. Using Private Docker Registry
      • 8. Example: Model Annotations Service
        • 8.1. Service Code
        • 8.2. Define the module
        • 8.3. Model and weights files
        • 8.4. Push the Package
        • 8.5. Deploy The Service
        • 8.6. Trigger the Service
        • 8.7. Uploading Model Weights as Artifacts
    • Task Workflows
      • 1. Creating Tasks
        • 1.1. Create A Task (Annotation task or QA task) Using Filter
        • 1.2. List of Items
        • 1.3. Entire Dataset
      • 2. Add items to an existing task
        • 2.1. By Filters
      • 3. Managing Tasks & Assignments
        • 3.1. Get Task
        • 3.2. Get Assignments
      • 4. Redistribute and Reassign Assignments
        • 4.1. Redistribute
    • Image Annotations
      • 1. Setup
        • 1.1. Initiation
        • 1.2. Optional Plotting
      • 2. Classification Point and Pose
        • 2.1. Classification
        • 2.2. Classify Multiple Items
        • 2.3. Create a Point Annotation
        • 2.4. Pose Annotation
      • 3. Bounding Box abd Cuboid
        • 3.1. Create Box Annotation
        • 3.2. Create a Rotated Bounding Box Annotation
        • 3.3. Convert Semantic Segmentation to Bounding Box
        • 3.4. Create Cuboid (3D Box) Annotation
      • 4. Polygon and Polyline
        • 4.1. Create Single Polygon/Polyline Annotation
        • 4.2. Create Multiple Polygons from Mask
        • 4.3. Convert Mask Annotations to Polygon
        • 4.4. Convert Polygon Annotation to Mask
      • 5. Ellipse and Item Description
        • 5.1. Create Ellipse Annotation
        • 5.2. Item Description
      • 6. Segmentation
        • 6.1. Init Segmentation
        • 6.2. Create a Semantic Segmentation Annotation
        • 6.3. Convert Mask to Polygon
        • 6.4. Convert Polygon to Mask
        • 6.5. Create Semantic Segmentation from Image Mask and Upload
      • 7. Advance Tutorials
        • 7.1. Copy Annotations Between Items
        • 7.2. Show Images & Annotations
        • 7.3. Show Annotations from JSON file (Dataloop format)
        • 7.4. Count total number of annotations
        • 7.5. Parenting Annotations
        • 7.6. Change Annotations’ Label
    • Video Annotations
      • 1. Setup
      • 2. Create A Single annotation
      • 3. Adding Multiple Annotations Using Annotation Builder
      • 4. Read Frames of an Annotation
      • 5. Create Frame Snapshots from Video
      • 6. Play An Item In Video Player
      • 7. Show Annotations in a Specified Frame
    • Recipe and Ontology
      • 1. Recipe and Ontology Concepts
      • 2. Preparing - Entities setup
      • 3. Create an Ontology
      • 4. Labels
      • 5. Attributes
      • 6. Add attributes to the ontology
      • 7. Read Ontology Attributes
      • 8. Getting all labels is (including children):
      • 9. Working With Recipes
      • 10. Cloning Recipes
      • 11. View Dataset Labels
      • 12. Add Labels by Dataset
      • 13. Add Labels Using Label Object
      • 14. Add a Label and Sub-Labels
      • 15. Add Hierarchy Labels with Nested
      • 16. Delete Labels by Dataset
      • 17. Update Label Features
    • Model Management
      • 1. Model Management
        • 1.1. Introduction
      • 2. Create Your own Model and Snapshot
      • 3. Dataloop Dataloader
        • 3.1. Object Detection Examples
        • 3.2. Segmentation Examples
        • 3.3. Setting a Label Map
        • 3.4. Batch size and batch_size and collate_fn
dtlpy
  • »
  • Search

© Copyright 2022, Dataloop Team. Revision 66a3a64c.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v1.65.24
Versions
latest
stable
v1.65.24
v1.64.9
v1.63.27
v1.62.10
v1.61.17
v1.61.16
v1.60.8
v1.59.21
v1.58.29
v1.57.31
v1.56.9
v1.55.10
v1.54.12
v1.53.48
v1.52.10
v1.51.18
v1.50.16
v1.49.20
v1.48.21
Downloads
On Read the Docs
Project Home
Builds