DatamintAPI

Contents

  • Getting Started with Datamint Python API
  • Installation
  • Setup API key
    • Method 1: Command-line tool (recommended)
    • Method 2: Environment variable
    • Method 3: Api constructor
    • Next Steps
  • 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
      • Associating uploaded segmentations with a deployed model
      • 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
      • Inspect annotations from a resource
      • Upload segmentations
      • Multi-class segmentations
      • Volume segmentations
      • Inspect annotation entities
    • Working with Projects
      • Create and manage projects
      • Project helper methods
    • Working with Channels
      • Organize resources with channels
    • Working with Models & Deployment
      • Running inference
  • PyTorch & Lightning Integration
    • Overview
    • PyTorch Dataset Integration
      • Basic PyTorch Usage
      • Dataset Transforms
  • Tutorials
    • Data Management
    • Annotations
    • Machine Learning & Deployment
    • Use Cases & End-to-End Examples

Python Modules Reference

  • Client API
    • Main API Module
      • Api
    • API Endpoints
      • Projects API
      • Resources API
      • Annotations API
      • Channels API
      • Users API
      • Annotation Sets API
      • Models API
      • Deploy Model API
      • Inference API
    • Base API Classes
      • Base API
      • Entity Base API
    • datamint.exceptions
      • DatamintException
      • EntityAlreadyExistsError
      • ItemNotFoundError
      • ResourceNotFoundError
    • datamint.api.dto
      • CreateAnnotationDto
  • Dataset Classes
    • Base Classes
      • DatamintBaseDataset
      • DatamintDatasetException
      • MultiFrameDataset
    • Specialised Datasets
      • ImageDataset
      • VolumeDataset
      • VideoDataset
    • Sliced Datasets
      • SlicedVolumeDataset
      • SlicedVideoDataset
    • Legacy Classes (Deprecated)
      • DatamintDataset
      • DatamintBaseDataset
      • DatamintDatasetException
  • Entities
    • Entity-first Workflows
      • Project objects
      • Resource objects
      • Annotation objects
    • Reference
      • Annotation
      • AnnotationSpec
      • BaseEntity
      • CacheManager
      • Channel
      • ChannelResourceData
      • DICOMResource
      • DatasetInfo
      • ImageResource
      • InferenceJob
      • LocalResource
      • NiftiResource
      • Project
      • Resource
      • User
      • VideoResource
      • VolumeResource
DatamintAPI
  • Python Module Index

Python Module Index

d
 
d
- datamint
    datamint.api.base_api
    datamint.api.client
    datamint.api.dto
    datamint.api.endpoints.annotations_api
    datamint.api.endpoints.annotationsets_api
    datamint.api.endpoints.channels_api
    datamint.api.endpoints.deploy_model_api
    datamint.api.endpoints.inference_api
    datamint.api.endpoints.models_api
    datamint.api.endpoints.projects_api
    datamint.api.endpoints.resources_api
    datamint.api.endpoints.users_api
    datamint.api.entity_base_api
    datamint.dataset.base
    datamint.dataset.base_dataset
    datamint.dataset.dataset
    datamint.dataset.image_dataset
    datamint.dataset.multiframe_dataset
    datamint.dataset.sliced_dataset
    datamint.dataset.sliced_video_dataset
    datamint.dataset.video_dataset
    datamint.dataset.volume_dataset
    datamint.entities
    datamint.exceptions

© Copyright 2024-2026, Sonance Team.

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