Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Qanat is currently in alpha. Use at your own risk.
Qanat 0.1.0 documentation
Qanat 0.1.0 documentation

Contents:

  • Features
  • Installation
  • Usage
    • Concepts and vocabulary
    • Running an experiment
      • Running a simple experiment with command-line arguments
      • Running with a file containing parameters
      • Running inside a container
      • Running through a job system
      • Running several groups of parameters in a single run
      • Running a run at a previous commit of the repository
      • Re-run a previous run of an experiment
    • Exploring runs of experiments
    • Showing progress of a run in qanat experiment status
    • CLI Reference
      • qanat init
      • qanat config
      • qanat cache
      • qanat dataset
      • qanat document
      • qanat experiment
      • qanat status
    • Description files
      • Dataset description file
      • Experiment description file
      • Run launching description file
  • Tutorials
    • Basics
      • 1 Getting Started
      • 2 Experiments, Datasets and description files
      • 3 Running experiments through a job system
    • Advanced tutorials
  • qanat
    • qanat package
      • qanat.cli_commands package
      • qanat.core package
      • qanat.utils package
  • Contributing
  • Credits
  • History
Back to top
View this page
Edit this page

Description filesΒΆ

Here you can find the reference documentation for the description files used in Qanat. Those are files allowing to add information to Qanat database without an interactive session, you need to create a description file. The description files are written in YAML format.

  • Dataset description file
  • Experiment description file
  • Run launching description file
Next
Dataset description file
Previous
qanat status
Copyright © 2023, Ammar Mian
Made with Sphinx and @pradyunsg's Furo