DatamintAPI

Contents

  • Installation
    • Next Steps
  • Setup API key
    • Method 1: Command-line tool (recommended)
    • Method 2: Environment variable
    • Method 3: Api constructor
  • Command-line tools
    • Configuring the Datamint settings
    • Uploading DICOMs/resources to Datamint server
      • Example using include and exclude extensions options:
      • Uploading segmentations along with the resources
      • All available options
  • Client Python API
    • Getting Started with the API Client
    • Working with Resources
      • Upload resource files
      • List and filter resources
      • Upload with options
    • Download resources
    • Publishing resources
    • Working with Annotations
      • Upload segmentations
      • Multi-class segmentations
    • Working with Projects
      • Create and manage projects
    • Working with Channels
      • Organize resources with channels
  • Pytorch integration
    • Dataset

Python Modules Reference

  • Client API
    • Main API Module
      • Api
    • API Endpoints
      • Projects API
      • Resources API
      • Annotations API
      • Channels API
      • Users API
    • Base API Classes
      • Base API
      • Entity Base API
    • datamint.exceptions
      • DatamintException
      • EntityAlreadyExistsError
      • ResourceNotFoundError
    • datamint.api.dto
      • AnnotationType
      • BoxGeometry
      • CreateAnnotationDto
      • Geometry
      • LineGeometry
  • Dataset Classes
    • DatamintDataset
      • DatamintDataset.__add__()
      • DatamintDataset.__getitem__()
      • DatamintDataset.__iter__()
      • DatamintDataset.__len__()
      • DatamintDataset.frame_categories_set
      • DatamintDataset.frame_labels_set
      • DatamintDataset.get_annotations()
      • DatamintDataset.get_collate_fn()
      • DatamintDataset.get_dataloader()
      • DatamintDataset.get_framelabel_distribution()
      • DatamintDataset.get_info()
      • DatamintDataset.get_resources_ids()
      • DatamintDataset.get_segmentationlabel_distribution()
      • DatamintDataset.image_categories_set
      • DatamintDataset.image_labels_set
      • DatamintDataset.read_number_of_frames()
      • DatamintDataset.segmentation_labels_set
      • DatamintDataset.subset()
    • DatamintBaseDataset
      • DatamintBaseDataset.__add__()
      • DatamintBaseDataset.__getitem__()
      • DatamintBaseDataset.__iter__()
      • DatamintBaseDataset.__len__()
      • DatamintBaseDataset.__repr__()
      • DatamintBaseDataset.frame_categories_set
      • DatamintBaseDataset.frame_labels_set
      • DatamintBaseDataset.get_annotations()
      • DatamintBaseDataset.get_collate_fn()
      • DatamintBaseDataset.get_dataloader()
      • DatamintBaseDataset.get_framelabel_distribution()
      • DatamintBaseDataset.get_info()
      • DatamintBaseDataset.get_resources_ids()
      • DatamintBaseDataset.get_segmentationlabel_distribution()
      • DatamintBaseDataset.image_categories_set
      • DatamintBaseDataset.image_labels_set
      • DatamintBaseDataset.read_number_of_frames()
      • DatamintBaseDataset.segmentation_labels_set
      • DatamintBaseDataset.subset()
    • DatamintDatasetException
  • Entities
    • Annotation
      • Annotation.id
      • Annotation.identifier
      • Annotation.scope
      • Annotation.frame_index
      • Annotation.annotation_type
      • Annotation.text_value
      • Annotation.numeric_value
      • Annotation.units
      • Annotation.geometry
      • Annotation.created_at
      • Annotation.created_by
      • Annotation.annotation_worklist_id
      • Annotation.status
      • Annotation.approved_at
      • Annotation.approved_by
      • Annotation.resource_id
      • Annotation.associated_file
      • Annotation.deleted
      • Annotation.deleted_at
      • Annotation.deleted_by
      • Annotation.created_by_model
      • Annotation.old_geometry
      • Annotation.set_name
      • Annotation.resource_filename
      • Annotation.resource_modality
      • Annotation.annotation_worklist_name
      • Annotation.user_info
      • Annotation.values
      • Annotation.added_by
      • Annotation.annotation_type
      • Annotation.annotation_worklist_id
      • Annotation.annotation_worklist_name
      • Annotation.approved_at
      • Annotation.approved_by
      • Annotation.associated_file
      • Annotation.created_at
      • Annotation.created_by
      • Annotation.created_by_model
      • Annotation.deleted
      • Annotation.deleted_at
      • Annotation.deleted_by
      • Annotation.fetch_file_data()
      • Annotation.file
      • Annotation.frame_index
      • Annotation.from_dict()
      • Annotation.geometry
      • Annotation.get_created_datetime()
      • Annotation.id
      • Annotation.identifier
      • Annotation.index
      • Annotation.invalidate_cache()
      • Annotation.is_category()
      • Annotation.is_frame_scoped()
      • Annotation.is_image_scoped()
      • Annotation.is_label()
      • Annotation.is_segmentation()
      • Annotation.model_config
      • Annotation.model_post_init()
      • Annotation.name
      • Annotation.numeric_value
      • Annotation.resource
      • Annotation.resource_filename
      • Annotation.resource_id
      • Annotation.resource_modality
      • Annotation.scope
      • Annotation.set_name
      • Annotation.status
      • Annotation.text_value
      • Annotation.type
      • Annotation.units
      • Annotation.user_info
      • Annotation.value
      • Annotation.values
    • BaseEntity
      • BaseEntity.asdict()
      • BaseEntity.asjson()
      • BaseEntity.is_attr_missing()
      • BaseEntity.model_config
      • BaseEntity.model_post_init()
    • CacheManager
      • CacheManager.cache_root
      • CacheManager.entity_type
      • CacheManager.ItemMetadata
      • CacheManager.clear_all()
      • CacheManager.get()
      • CacheManager.get_cache_info()
      • CacheManager.invalidate()
      • CacheManager.set()
    • Channel
      • Channel.channel_name
      • Channel.resource_data
      • Channel.deleted
      • Channel.created_at
      • Channel.updated_at
      • Channel.channel_name
      • Channel.created_at
      • Channel.deleted
      • Channel.get_resource_ids()
      • Channel.model_config
      • Channel.model_post_init()
      • Channel.resource_data
      • Channel.updated_at
    • ChannelResourceData
      • ChannelResourceData.created_by
      • ChannelResourceData.customer_id
      • ChannelResourceData.resource_id
      • ChannelResourceData.resource_file_name
      • ChannelResourceData.resource_mimetype
      • ChannelResourceData.created_by
      • ChannelResourceData.customer_id
      • ChannelResourceData.model_config
      • ChannelResourceData.resource_file_name
      • ChannelResourceData.resource_id
      • ChannelResourceData.resource_mimetype
    • DatasetInfo
      • DatasetInfo.created_at
      • DatasetInfo.created_by
      • DatasetInfo.customer_id
      • DatasetInfo.description
      • DatasetInfo.get_projects()
      • DatasetInfo.get_resources()
      • DatasetInfo.id
      • DatasetInfo.invalidate_cache()
      • DatasetInfo.model_config
      • DatasetInfo.model_post_init()
      • DatasetInfo.name
      • DatasetInfo.resource_ids
      • DatasetInfo.total_resource
      • DatasetInfo.updated_at
    • Project
      • Project.id
      • Project.name
      • Project.description
      • Project.created_at
      • Project.created_by
      • Project.dataset_id
      • Project.worklist_id
      • Project.ai_model_id
      • Project.viewable_ai_segs
      • Project.editable_ai_segs
      • Project.archived
      • Project.resource_count
      • Project.annotated_resource_count
      • Project.most_recent_experiment
      • Project.closed_resources_count
      • Project.resources_to_annotate_count
      • Project.annotators
      • Project.ai_model_id
      • Project.annotated_resource_count
      • Project.annotators
      • Project.archived
      • Project.archived_by
      • Project.archived_on
      • Project.as_torch_dataset()
      • Project.closed_resources_count
      • Project.created_at
      • Project.created_by
      • Project.dataset_id
      • Project.description
      • Project.editable_ai_segs
      • Project.fetch_resources()
      • Project.id
      • Project.is_active_learning
      • Project.model_config
      • Project.model_post_init()
      • Project.most_recent_experiment
      • Project.name
      • Project.registered_model
      • Project.require_review
      • Project.resource_count
      • Project.resources_to_annotate_count
      • Project.set_work_status()
      • Project.show()
      • Project.two_up_display
      • Project.url
      • Project.viewable_ai_segs
      • Project.worklist_id
    • Resource
      • Resource.id
      • Resource.resource_uri
      • Resource.storage
      • Resource.location
      • Resource.upload_channel
      • Resource.filename
      • Resource.modality
      • Resource.mimetype
      • Resource.size
      • Resource.upload_mechanism
      • Resource.customer_id
      • Resource.status
      • Resource.created_at
      • Resource.created_by
      • Resource.published
      • Resource.published_on
      • Resource.published_by
      • Resource.publish_transforms
      • Resource.deleted
      • Resource.deleted_at
      • Resource.deleted_by
      • Resource.metadata
      • Resource.source_filepath
      • Resource.tags
      • Resource.instance_uid
      • Resource.series_uid
      • Resource.study_uid
      • Resource.patient_id
      • Resource.segmentations
      • Resource.measurements
      • Resource.categories
      • Resource.labels
      • Resource.user_info
      • Resource.projects
      • Resource.__repr__()
      • Resource.__str__()
      • Resource.categories
      • Resource.created_at
      • Resource.created_by
      • Resource.customer_id
      • Resource.deleted
      • Resource.deleted_at
      • Resource.deleted_by
      • Resource.fetch_annotations()
      • Resource.fetch_file_data()
      • Resource.filename
      • Resource.id
      • Resource.instance_uid
      • Resource.invalidate_cache()
      • Resource.is_dicom()
      • Resource.location
      • Resource.measurements
      • Resource.metadata
      • Resource.mimetype
      • Resource.modality
      • Resource.model_config
      • Resource.model_post_init()
      • Resource.patient_id
      • Resource.projects
      • Resource.publish_transforms
      • Resource.published
      • Resource.published_by
      • Resource.published_on
      • Resource.resource_uri
      • Resource.segmentations
      • Resource.series_uid
      • Resource.show()
      • Resource.size
      • Resource.size_mb
      • Resource.source_filepath
      • Resource.status
      • Resource.storage
      • Resource.study_uid
      • Resource.tags
      • Resource.upload_channel
      • Resource.upload_mechanism
      • Resource.url
      • Resource.user_info
    • User
      • User.email
      • User.firstname
      • User.lastname
      • User.roles
      • User.customer_id
      • User.created_at
      • User.created_at
      • User.customer_id
      • User.email
      • User.firstname
      • User.lastname
      • User.model_config
      • User.model_post_init()
      • User.roles
DatamintAPI
  • Documentation
  • View page source

Datamint

Documentation

Version: 2.3.3

From inception to completion, Datamint is your reliable partner. It assists from the very first day when you make your data available to your team, right up to the moment you’re set to launch your model.

Datamint

  • Homepage

  • Datamint Platform

  • Github

Contents

  • Installation
    • Next Steps
  • Setup API key
    • Method 1: Command-line tool (recommended)
    • Method 2: Environment variable
    • Method 3: Api constructor
  • Command-line tools
    • Configuring the Datamint settings
    • Uploading DICOMs/resources to Datamint server
  • Client Python API
    • Getting Started with the API Client
    • Working with Resources
    • Download resources
    • Publishing resources
    • Working with Annotations
    • Working with Projects
    • Working with Channels
  • Pytorch integration
    • Dataset

Python Modules Reference

  • Client API
  • Dataset Classes
  • Entities

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2024, Sonance Team.

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