datature 1.6.0

Python bindings for the Datature API

:hammer: Datature Python SDK :hammer:

---

:zap: Empower your MLOps pipelines and applications with seamless integrations :zap:

Automate tasks to manage your datasets, run training experiments, export and deploy your models from Datature Nexus with ease. Perform development via Python scripts or with the CLI - your choice!

---

:rocket: Getting Started :rocket:

:snake: Prerequisites

• 3.8 <= Python <= 3.12

We recommend users to create a virtual environment before installing any dependencies. For more information on virtual environments, please refer to:

• Python venv
• Conda
• virtualenvwrapper

:gear: Installation

pip install --upgrade datature

---

Python Usage

For a full list of documentation and examples, please refer to the API docs.

Authentication

To get started, you will first need to create a project on Datature Nexus (signing up is free!). You will then need to locate the project secret key. This key can only be accessed if you are the Project Owner or been granted elevated permissions by the Project Owner, and will be used for all subsequent authentication when invoking the various SDK functions.

Examples

To list projects:

from datature import nexus

client = nexus.Client("3736971xxxxx")

projects = client.list_projects()

To upload assets:

import os
from datature import nexus

logging.basicConfig()

client = nexus.Client("3736971xxxxx")

project = client.list_projects("proj_xxxxx")


upload_session = project.assets.create_upload_session(groups=["dataset"])

with upload_session as session:
  session.add_path("/Users/dataset")

print(len(upload_session))

Logging

You can vary the logging level depending on your task or use case (such as DEBUG to provide more insights), but the default INFO level is typically best suited for production use.

import logging

logging.basicConfig()
logging.getLogger("nexus").setLevel(logging.DEBUG)

---

CLI Usage

For a full list of documentation and examples, please refer to the CLI docs.

Authentication

To get started, you will first need to create a project on Datature Nexus (signing up is free!). You will then need to locate the project secret key. This key can only be accessed if you are the Project Owner or been granted elevated permissions by the Project Owner, and will be used for all subsequent authentication when invoking the various SDK functions.

Once you have the project secret, you will now be able to make API requests using the CLI by entering the command datature projects auth:

datature projects auth
[?] Enter the project secret: ************************************************
[?] Make [Your Project Name] the default project? (Y/n): y

Authentication succeeded.

You will now be able to run your desired CLI commands as outlined above. To see all possible functions as well as view the required inputs and expected outputs, check out the following documentation.

Project Management

datature projects

Show a help page of various functions to add projects, select the default project, and retrieve project information.

Auth Project

datature projects auth

Authenticate new projects using the project secret key. Multiple projects can be authenticated and stored using different secret keys.

Select Project

datature projects select

Select an active project to work on from a list of saved projects. All subsequent CLI commands will be in the context of the selected project until a different project is selected, or the shell session is terminated.

$ datature projects select

> My Cool Project
  New Test Project

Your active project is now: [Dicom]

List Projects

datature projects list

View a table of saved projects with columns containing the names of the projects, the total number of assets, the number of annotated assets, the number of annotations, and the number of tags for each project. The name of the active project is displayed at the bottom of the list.

$ datature projects list

NAME                TOTAL_ASSETS        ANNOTATED_ASSETS    ANNOTATIONS         TAGS
My Cool Project     4071                433                 1874                3
New Test Project    718                 53                  959                 4

Your active project is now: [My Cool Project]

Asset Management

Upload Assets

datature assets upload

Upload assets to Datature Nexus. You will be prompted to enter the path to the folder containing the assets that you wish to upload, as well as optional group name(s) to categorize the set of assets. This function is designed specially for bulk uploading of large datasets, which accelerates the process of onboarding data for subsequent annotation and training.

This function also supports DICOM and NIfTI file upload, which caters to important medical use cases.

$ datature asset upload
[?] Enter the assets folder path to be uploaded: /Downloads/Training2
[?] Enter the assets group name(s), split by ',': main
[?] 281 assets will be uploaded to group(s) (main)? (Y/n):
Preparing    |████████████████████████████████████████| 281/281 [100%] in 0.1s (2775.28/s)
Processing   |████████████████████████████████████████| 100% [281/281] in 1:17.5 (3.56/s)
Server processing completed.

Group Assets

datature assets groups

List asset group information within your project. You will be prompted to select an existing group or create a new group. If you select an existing group, information about the selected group will be displayed, including the total number of assets in the group, the number of assets that have been annotated, reviewed, or marked for fixes, and the number of assets that have been completed.

$ datature assets groups

> main
  groupName2

NAME            TOTAL           ANNOTATED       REVIEW          TOFIX           COMPLETED
main            8               1               0               0               0

Annotation Management

Upload Annotations

datature annotations upload

Upload annotation files to Datature Nexus You will be prompted to enter the path of the annotation file you wish to upload and select a supported annotation format.

$ datature annotations upload
[?] Enter the annotation files path to be uploaded: /Users/Downloads/Training.csv
Processing   |████████████████████████████████████████| 100% [1/1] in 7.0s (0.14/s)
Server processing completed.

Download Annotations

datature annotations download

Download annotation files from Datature Nexus. You will be prompted to enter a path to save the downloaded annotation file to, and select the desired annotation format.

$ datature annotations download
[?] Enter the annotation files path to be download: /Users/Downloads/
[?] Select the annotation file format: csv_widthheight
   csv_fourcorner
 > csv_widthheight
   coco
   pascal_voc
   yolo_keras_pytorch
   yolo_darknet
   polygon_single
   polygon_coco

Processing   |████████████████████████████████████████| 100% [1/1] in 7.0s (0.14/s)
Server processing completed.

Artifact Management

Artifact Download

datature artifacts download

Download a model artifact from Datature Nexus. You will be prompted to enter a folder path to save the model to, and select the name and export format of the artifact to download.

$ datature artifacts download
[?] Enter the folder path to save model: /Volumes/
[?] Which artifact do you want to download?: BEAF45-Workflowc
 > BEAF45-Workflowc

[?] Which model format do you want to download?: tensorflow
 > tensorflow
   tflite
   onnx

Downloading  |████████████████████████████████████████| 100% [443421394/443421394] in 7.1s (62639992.12/s)