Skip to main content
Ctrl+K

Dioptra 1.1.0 documentation

  • Dioptra Overview

What is Dioptra?

  • Motivation
  • Design Principles
  • Intended Audience
  • Architecture Overview

Setup

  • Install Dioptra
    • Get the Container Images
      • Download the Container Images
      • Build the Container Images
    • Prepare Your Deployment
    • Update Your Deployment
  • Customize Your Setup
    • Use Docker Compose Override Files
    • Mount Data Volumes
    • Configure GPU Workers
    • Add Custom CA Certificates
    • Enable SSL/TLS in NGINX and Postgres
    • Create a Custom Worker Container
    • Integrate Custom Containers
  • Setup Reference
    • Deployment Template Reference
    • Deployment Folder Reference
    • init-deployment.sh Script Reference
    • Deployment Commands Reference
    • Custom Worker Template Reference
    • dioptra-worker-v1 Reference
    • Worker Container Requirements Reference

Explainers

  • Workflow Architecture
  • Dioptra Components
    • Queues and Workers
    • Users and Groups
    • Plugin Parameter Types
    • Plugins
    • Entrypoints
    • Task Graph
    • Artifacts
    • Experiments and Jobs
  • Usage Modes

Tutorials

  • Hello World in Dioptra
    • Set Up Dioptra in the GUI
    • Running Hello World
  • Learning the Essentials
    • Adding Inputs and Outputs
    • Building a Multi-Step Workflow
    • Saving Artifacts
    • Using Saved Artifacts
  • Advanced Tutorials

How Tos

  • Running Experiments
    • Set Up the Python Client
    • Create Queues
    • Create Users and Groups
    • Create Parameter Types
    • Create Plugins
    • Logging Metrics
    • Create Entrypoints
    • Create Experiments
    • Running Jobs
  • Importing Content
    • Add a Dataset
    • Import Resources
  • Advanced
    • Distribute Plugins
    • Develop for Dioptra

Reference

  • Glossary
  • Dioptra Components
    • Users
    • Groups
    • Queues
    • Plugin Parameter Types
    • Plugins
    • Entrypoints
    • Experiments
    • Jobs
    • Artifacts
    • Metrics
    • Workers
  • Python Client Methods
    • Auth, Users, and Groups Client Methods
    • Queues Client Methods
    • Parameter Types Client Methods
    • Plugins Client Methods
    • Entrypoints Client Methods
    • Experiments Client Methods
    • Jobs Client Methods
    • Artifacts Client Methods
    • Tags Client Methods
    • Snapshots Client Methods
    • Workflows Client Methods
  • REST API Reference
  • Resource Import Syntax
  • Resource Search Language Syntax
  • Declarative Experiment Description
  • Guidelines for Documentation
  • .rst

Setup Reference

Setup Reference#

This section contains technical reference documentation for Dioptra deployment configuration. Use these documents for quick lookup of configuration options, folder structures, script parameters, and common commands.

Table of Contents

  • Deployment Template Reference
  • Deployment Folder Reference
  • init-deployment.sh Script Reference
  • Deployment Commands Reference
  • Custom Worker Template Reference
  • dioptra-worker-v1 Reference
  • Worker Container Requirements Reference

previous

Integrate Custom Containers

next

Deployment Template Reference
× enlarged screenshot