Jump to Content
Diffgram DocsDocumentationAPI ReferenceCommunity
HomeDocumentationAPI Reference
DocumentationAPI ReferenceCommunityLog InDiffgram Docs
Documentation
Log In
HomeDocumentationAPI Reference

Getting Started

  • The AI Datastore
    • Use Diffgram with Your Apps
  • Setup Guide
    • Install Setup
    • Schema Setup
    • Tasks Setup
    • End User Setup
    • Data Setup
    • Data Catalog Setup
    • Workflow Setup
    • Initial Usage
    • Optimization Setup
    • Terminology Glossary
    • Project Concept 101
    • ML Backend, Pre-Label and Auto Annotate
    • Makefile Automation Option
  • Developer Install Using Docker Compose
    • Debugging A Dev Install
    • Docker Install Cheatsheet
    • AWS Installation Problems
    • Service Status
    • Air Gap / SCIF
    • Breaking Changes
    • Supported Operating Systems
    • After Install
    • Super Admin Getting Started
  • Options
    • Mail
    • Disable User Self Registration
  • Update
    • Update Dev
    • Update Production
  • Production Installation
    • OIDC Config (OAuth 2.0)
    • Helm & Kubernetes: Installation
    • Domain Configuration
    • Metrics and Diffgram Corporate Access
  • Migrations
    • Labelbox to Diffgram
    • Labelstudio / Heartex to Diffgram
  • SDK and CLI
    • Diffgram SDK
    • Diffgram CLI
  • Optimize
    • Capacity Planning
    • Super Admin Guide
    • Super Admin Support Guide
    • Super Admin Special Abilities
    • Super Admin Internal Request Routing
    • Super Admin General System Maintenance
    • Super Admin Restarting
  • Support
    • Support Ticket Requirements
  • University
    • Training Data Book
    • Classic and New Supervised Machine Learning

About

  • Diffgram License v2 (DLv2)
    • Diffgram Contributor License (CL)
    • Master Services Agreement (MSA)
  • Features
  • Why Choose Diffgram?
    • Standards
    • Open Source
    • Cybersecurity for Training Data 101
  • Sales
    • Advisory Board
  • Vision
  • Quality Bar Status

Open Source

  • Community
  • Contributing
    • Review Us
    • Good First Contributions
    • Developer Contribution Guide
    • Code Review Guidelines
    • Git Tags For Issues & Pull Requests
    • How to Make a Pull Request without Repo Access
    • New Engineer Welcome
    • Caching Engineering Notes
    • Diffgram Improvement Proposals [DIP] Reference
    • Unit Testing Backend Guidelines
    • Editing the Docs
    • Staging Environment
    • Contributing New Configs Settings / Env Variables to Diffgram Backend Services
  • Backend Architecture
    • Secrets (Environment Variables)
    • Kubernetes (K8s) Architecture
    • Customization Overview
    • Scale
    • Annotation Direction
    • Code in JS - Presentation Layer in Vue
    • Testing End to End
  • Performance
    • API Performance - Backend
    • API Performance - Frontend
    • File Processing Performance Notes
    • Video Buffer Performance - Low Level Spec
  • Releases
  • Ecosystem

Schema

  • Schema
    • Schema University
  • Create Your First Label
  • Attributes
    • Attributes Concepts
    • Attribute Types Index
    • Attribute Annotation
    • Global Attributes
    • Tree Annotation
    • Attributes Ordering
    • Attribute Scope
    • Attribute Access Control
    • Attributes Export Spec
    • Contextual Attributes (Triggers)
  • Custom Instance Templates

Customization

  • White Label UI Customization Introduction
  • Set Install Logo
  • Custom Buttons

Data

  • Ingest Data
    • Importing Introduction
    • Storage Providers List
    • Importing Files Using Connections
    • Importing Instances Walkthrough
    • Instance List Format Reference
    • Import Admin
    • Importing Files & Instances on the Upload Wizard
    • Import from Diffgram Annotations Export
    • Migrating Diffgram Project From External Sources
    • Import Wizard Example Format
    • One Click Migration from Labelbox
    • Upload Files By Reference
    • Storage Tier Best Practices
    • Uploading & Updating Files With Attributes
    • Compound Files Ingestion
    • Ingesting Instances from MongoDB Tutorial
  • Export Data
    • Streaming Data
    • Export Walkthrough
    • Export Format
    • Exporting With Connections
    • EXIF Orientation Assumptions for Images
    • Export Converters
    • Reading Export File Example
    • Generating Masks from Polygon
    • Accessing Attributes
  • BLOBs

Annotation Tasks

  • Tasks
    • Tasks Introduction
    • Tasks & Projects
    • Tasks Creation
    • Task Tags
    • Task Analytics
    • Review Loop 101
    • Automatic Assignment 101
    • Task Streams 101
    • Task Annotation Actions
    • Exams Benchmark Introductions
    • Tasks FAQ
    • Measure Data Quality (Annotations & More)
    • Pipelines Cookbook
    • Create a Good & Bad Review Pipeline
    • Task Statuses
  • Task Admin
    • User Task Management
    • See Related Files or Tasks
    • Uncomplete a Task
  • Updating Tasks
    • Changing the Task Schema
    • Timing of work (Advanced)
  • External Integrations
    • Scale AI Integration
    • Labelbox Integration
  • Task Template Statuses

Annotation

  • Annotation Summary
  • Image Annotation
    • 2D Bounding Box
    • Semantic Segmentation - Vector Annotation
    • Polygon Tracing
    • Keypoints Annotation Type
  • Video Annotation
    • Video Attributes
    • Video Series
    • Video Annotation Concepts
    • Video Interpolation
    • Video Annotation Ghost Frames 👻
    • Video Import Specifications
    • Video Import Specifications
  • 3D Annotation
    • 3D Annotation Guide
  • Text Annotation
    • Tutorial overview
    • Import txt to Diffgram
    • Create Schema
    • Annotate
    • Apply attributes
    • Apply global attributes
    • Export Text Data
  • Conversational Annotation & LLM (Preview)
  • Audio Annotation
    • Audio Annotation Admin Guide
    • Audio Annotation Annotator Help
  • Geospatial Annotation
    • Tutorial overview
    • Import GeoTiff to Diffgram
    • Create Schema
    • Annotate
    • Apply attributes
    • Apply global attributes
    • Geospatial Export Data
  • Multi-Modal Annotation
  • Shared Annotation Features
    • Common Annotation Features
    • Snap To Annotation
    • Annotation Show - QA
    • Context Menus
    • Image and Video: Zoom and move window

About Diffgram

  • What is Diffgram?
    • Development Cycles & Benefits
    • What is the Value Add?
    • Total Cost of Ownership
  • Compatibility
    • Common Questions
    • Minimum Specs

Interactive Scripts Framework

  • Interactive Script Framework
    • Why Userscripts
    • Researchers - Sharing your ideas
    • UserScript Direction
    • Userscript FAQ
    • Quickstart (Userscripts Annotation Automation)
  • Userscript Examples
    • Bodypix (People Segmentation & Keypoints)
    • Object Detection - cocoSsd (Userscript)
    • Box to Polygon (Using GrabCut)
    • Full Image Tags (.ml5 js Userscript Example)
    • Face landmark detection (Userscript Example)
    • Face Detection (Userscript Example)
    • Generic Watcher Example
    • Duplicate Detection Example
    • Duplicate Detection Specific Class
    • Warn if a specific class is missing
  • Interactions & Events
    • create_instance
  • Script Functions
    • create_box
    • create_polygon
    • get_roi_canvas_from_instance
    • get_new_canvas (Image/Frame)
    • get_metadata
    • show_snackbar
  • Userscript Data Primitives
    • Userscript Interface Primitives
  • Editing Scripts
    • Accessing Media
    • Editor Errors & Logging
    • Performance (userscripts)
    • Getting Scripts to Annotators
    • Dependencies
    • Fix: CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

Reporting

  • Reporting
    • Reporting Introduction
    • Report Concepts
    • Report Generator
    • Double Group By Report

Notifications & Webhooks

  • Setting Up Email Notifications
  • Setting Up Webhooks
  • Setup Email SMTP Provider

Connections & Integrations

  • Connections Introduction
  • New Connection
    • Amazon Web Services (AWS) Connection
    • Google (GCP) Connection Requirements
    • Azure Connection
    • MinIO
    • Custom URL Signer

Teams & Collaboration

  • Role Based Access Control
  • Permalink - Deep Linking
  • Issues

Catalog

  • Catalog
    • Access Data - Queries Overview
    • Compare Model Results
    • Query Syntax Reference
  • Datasets Introduction
    • Viewing Files - File Management
    • Moving, Copying, and Adding Files to Datasets
    • Delete Files

SDK Methods

  • Directory (Dataset)
    • new()
    • list_files()
    • get()
    • add()
    • set_directory_by_name()
    • slice()
    • to_tensorflow()
    • to_pytorch()
  • Job New SDK
  • Job Launch Logs
  • Files
    • update()
  • Diffgram Python SDK
  • File3D
    • add_point()
    • upload()
  • Schema (SDK) Methods
  • Unsupported API method with SDK
  • Task Template (Job) SDK
  • Compound File
    • from_dict
    • update_all
    • remove_child_file
    • add_child_from_local

Security

  • Security Policies
    • Organizational Security
    • Software Production Security
    • Open Source Security
    • Identity
    • Cloud Security
    • Access Security
    • Vendor and Risk Management
  • Compliance
  • Security Advisories
  • Reporting a Vulnerability
  • Login, Magic Login and Password
  • 2 Factor Authentication (2FA)
  • Setting Keycloak on Diffgram
  • Setting AWS Cognito on Diffgram
  • Custom Roles Management
  • Diffgram Default Roles
  • User Permissions
  • Setting Super Admin Users

Embedded

  • Development System
    • Baseline
    • Frameworks
    • Components
    • Specification
  • Embed
    • React Embedded Sample

Misc

  • Glossary List
  • Project Shutdown
  • Project Settings Navigation
  • Training Data Tutorials

Hiring

  • Diffgram Hiring Process
    • Intro Call 101
    • Remote Meeting Quality
    • Technical Interview Success - System Design
  • Why Join the Diffgram Core Team?

Developer Docs

  • Developer Docs
    • Storybook
  • Events
  • Data_Tools
    • create_resumable_upload_session()
    • transmit_chunk_of_resumable_upload()
    • download_from_cloud_to_local_file
    • upload_to_cloud_storage()
    • upload_from_string()
    • download_bytes()
    • download_from_cloud_to_local_file()
    • get_image()
    • build_secure_url()
    • get_string_from_blob()
    • rebuild_secure_urls_image()
  • CanvasMouseTools
    • zoom_to_point()
    • pan_x()
    • pan_y()
    • mouse_transform()
    • reset_transform_with_global_scale(0
    • perform_zoom_delta()
    • zoom_wheel()
    • auto_align_borders_on_zoom_out
  • Process Media Designs
    • PrioritizedItem
    • Remote Queue - start_queue_check_loop
    • Remote Queue - check_if_add_items_to_queue
    • add_item_to_queue
    • Process Media - Local Worker Queues
    • download_from_url (Process Media)
    • process_media_queue_getter
  • Front-end unit testing
  • Backend Introduction
  • Command pattern
  • Walrus
  • Frontend Success and Error Handling
  • canvas_scale_global()

Workflows

  • Action Workflows Introduction
    • Zero Shot Classification (Hugging Face)
    • JSON Export
    • Human Tasks
    • Deepchecks Image Properties Outliers
    • Vertex AI: Train model
  • Workflows for developers
  • Developing your Custom Actions
  • Actions Base Classes Reference
    • ActionRunner
    • ActionCompleteCondition
    • ActionCondition
    • ActionTrigger

Competition

  • Best AI Datastore Alternatives
    • Best V7 Labs Alternative is Diffgram
    • Best Super Annotate alternative is Diffgram
    • The Best Labelbox Alternative is Diffgram
    • The Best Label Studio Alternative is Diffgram
Powered by