Contents Menu Expand
Valohai documentation
Logo
Valohai documentation
  • Tutorials
    • Valohai 101 (Python)
      • Use parameters
      • Download input data
      • Collect and view metrics
      • Deploy a model for online inference
      • Create a pipeline
    • Jupyter Notebooks
    • Build your own Docker image
    • Valohai APIs
      • Valohai API - Basics
      • Fetch failed executions with Valohai APIs
      • Download metadata of a single execution
      • Trigger an execution after a push to a code repository
    • Valohai CLI client
      • Using the Command-line Client
      • Choosing Execution Environment
      • Using Inputs with valohai-cli
    • Example projects
      • Keras - Example project
      • R - Example Project
      • Tensorflow - Example project
      • Valohai API Tutorial
    • Using with Airflow Pipelines
  • How-to guides
    • Connect to a Git-repository
      • Integrating with GitHub
      • Integrating with Bitbucket
      • Integrating with GitLab
      • Access additional git repository during execution runs
    • Work with data
      • Add a cloud data store
        • Add Azure Blob Storage
        • Add Google Cloud Storage
        • Add AWS S3
        • Add OpenStack Swift
      • Save files from executions
      • Upload data to Valohai
      • Mounting a network file system (NFS)
    • Compare executions
    • Save graphs from executions
    • Tasks
      • Running a Grid search
      • Using the Bayesian optimizer
    • Access a private Docker repository
    • Pipelines
      • Schedule pipelines
      • Run a Task inside a pipeline
    • Organization settings
      • Environments
        • Configure environments and scaling rules
        • Change your organizations default environment
        • Manage team quotas for environments
        • Choose which environments are available
      • Users and teams
        • Add users to your organization
        • Create teams in your organization
      • Billing & credit card
      • Integrating with Azure Active Directory
    • Test your deployment endpoint
  • Topic guides
    • Core Concepts
      • Projects
      • Valohai YAML
      • Step
      • Executions
      • Parameters
      • Data Stores
      • Tasks
      • Pipelines
      • Deployments
      • Notebooks
    • Workload Management
      • Creating Executions
      • Placeholder-based Configuration
      • File-based Configuration
      • Variable-based Configuration
      • Real-time Logging
      • Creating Visualizations
      • Downloading Files to Executions
      • Uploading Files from Executions
      • Live Outputs
    • Architecture Overview
    • Reproducibility and lineage
    • Docker Images
    • Running Valohai Inside Your Own Cloud or On-premise Environment
      • Selecting Compute Instances
      • Choosing the Right Valohai Environment
      • On-premises Installations
        • Mounting a Directory
        • Using On-premises Workers
        • Managing On-premises Workers
  • Reference guides
    • valohai.yaml - Config File
      • step
      • step.name
      • step.image
      • step.command
      • step.parameters
      • step.inputs
      • step.environment
      • step.environment-variables
      • Special environment variables
      • pipeline
      • pipeline.nodes
      • pipeline.edges
      • endpoint
      • endpoint from a command
      • endpoint from a WSGI definition
      • Examples
    • Command-line Reference
      • vh environments
      • vh execution
      • vh init
      • vh lint
      • vh login
      • vh logout
      • vh parcel
      • vh project
      • vh update-check
    • API
    • API docs

Reference guides¶

Reference guides contain technical reference for APIs and other aspects of Valohai They describe how it works and how to use it but assume that you have a basic understanding of key concepts.

  • valohai.yaml - Config File
  • Command-line Reference
  • API
  • API docs
🐞 Give feedback about this page
Next
valohai.yaml - Config File
Previous
Managing On-premises Workers
Copyright © 2016 - 2021, Valohai