orion
v0.1.9

Welcome

  • Getting Started
    • Integration
      • Python API
    • Optimize
      • Scaling up
    • Search Space
    • Algorithms
    • Monitoring
    • Next steps
  • Installing Oríon
    • Bleeding edge
  • Database Setup
    • Configuring the database
      • Testing the configuration
    • Supported databases
      • EphemeralDB
        • Arguments
      • PickledDB
        • Arguments
      • MongoDB
        • Arguments
    • Installing MongoDB
      • MongoDB Atlas
    • Upgrading the database

User Guide

  • Overview
  • Integrate
    • Orion customization
      • user_script_config
      • working_dir
    • Language compatibility
    • Command-line templating
    • Environment variables
  • Optimize
    • Command line API
    • Python APIs
      • Service API
      • Framework API
  • Algorithms
    • Selecting and Configuring
    • Included Algorithms
      • Random Search
        • Configuration
      • Hyperband
        • Configuration
      • ASHA
        • Configuration
      • TPE
        • Configuration
      • Evolution-ES
        • Configuration
    • Algorithm Plugins
      • Bayesian Optimizer
        • Installation
        • Configuration
    • Parallel Strategies
      • NoParallelStrategy
      • StubParallelStrategy
      • MaxParallelStrategy
      • MeanParallelStrategy
  • Search Space
    • Priors
      • uniform(low, high)
      • loguniform(low, high)
      • normal(loc, scale)
      • gaussian(loc, scale)
      • choices(options)
      • fidelity(low, high, base=2)
    • Dimension Types
      • Real
      • Integer
      • Categorical
      • Fidelity
    • Special arguments
      • discrete
      • default_value
      • precision
      • shape
    • Configuration
      • Commandline
      • Configuration file
    • Notes
      • Tranformations
        • Real
        • Integer
      • Conditional dependencies
    • References
  • Monitoring
    • Commands for terminal
      • list Overview of all experiments
        • Configuration
        • Basic Usage
        • The --name argument
      • status Overview of trials for experiments
        • Basic Usage
        • The --all Argument
        • The --collapse Argument
        • The --name Argument
        • status and the experiment tree
      • info Detailed informations about experiments
        • The --name argument
        • The --version argument
    • Library API
      • Results
      • Iterative Results with EVC
    • Web API
      • Authentication
      • Runtime
      • Experiments
      • Trials
      • Plots
      • Errors
  • Experiment Version Control
    • Source of conflicts
      • Iterative Results
  • Storage
    • Commands
      • setup Storage configuration
      • test Test storage configuration
      • rm Delete data from storage
      • set Change value of data in storage
      • upgrade Upgrade database scheme
    • Python APIs
      • ExperimentClient
        • fetch_trials
        • fetch_trials_by_status
        • fetch_noncompleted_trials
        • get_trial
        • insert
      • Storage
        • update_experiment
        • fetch_experiments
        • delete_experiment
        • register_trial
        • reserve_trial
        • fetch_trials
        • delete_trials
        • get_trial
        • update_trials
        • update_trial
        • fetch_lost_trials
        • fetch_pending_trials
        • fetch_noncompleted_trials
        • fetch_trials_by_status
        • count_completed_trials
        • count_broken_trials
        • set_trial_status
      • Database
        • read
        • write
        • remove
        • read_and_write
  • Advanced Configuration
    • Full Example of Global Configuration
    • Database
      • name
      • type
      • host
      • port
    • Experiment
      • name
      • version
      • user
      • max_trials
      • worker_trials
      • max_broken
      • working_dir
      • pool_size
      • algorithms
      • strategy
    • Worker
      • heartbeat
      • max_trials
      • max_broken
      • max_idle_time
      • interrupt_signal_code
      • user_script_config
    • Experiment Version Control
      • auto_resolution
      • manual_resolution
      • non_monitored_arguments
      • ignore_code_changes
      • algorithm_change
      • code_change_type
      • cli_change_type
      • config_change_type
  • Parallel Workers

Tutorials

  • Scikit-learn
    • Sample script
    • Enter Orion
      • Updating the script
      • Updating the script call
    • Viewing the results
  • PyTorch MNIST
    • Installation and setup
    • Adapting the code for Oríon
    • Execution
    • Results
    • Notes
    • Debugging
      • Hunting Options
  • Running on HPC
    • Parallel optimization using arrays
    • SSH tunnels
      • Notes for MongoDB
        • SSL
        • Replica Sets
  • PyTorch CIFAR10
  • PyTorch A2C PPO ACKTR
    • Intro
    • What to change
    • How to search for hyperparameters

Plugins

  • Overview
  • Installing
    • Algorithms
      • Skopt algorithms
  • Developing algorithms
    • Usage
    • Implementation
    • Tests

Developer Guide

  • Overview
  • Getting started
    • Oríon
    • Database
    • Verifying the installation
    • About tox
  • Conventions
    • Coding standard
    • Version Control Guidelines
      • Synchronization
    • Documenting standard
    • Repository standard
    • Versioning standard
    • GitHub labels
      • Topic
      • Addition
      • Improvement
      • Problems
      • Status
      • Discussion
      • Community
      • Priority
      • Inactive
  • Testing
    • Running tests
    • Stress Tests
      • Execution
      • Results
  • Documenting
    • Updating README.rst
    • Building documentation
  • Continuous Integration
  • Releasing
    • Creating a release candidate
    • Making the release
    • After the release

Code Reference

  • Algorithm modules
    • Space search
      • orion.algo.space – Objects describing a problem’s domain
    • Base definition of algorithms
      • orion.algo.base – What is a search algorithm, optimizer of a process
    • Random Search Algorithm
      • orion.algo.random – Random sampler as optimization algorithm
    • Hyperband Algorithm
      • orion.algo.hyperband – A Novel Bandit-Based Approach to Hyperparameter Optimization
    • Asynchronous Successive Halving Algorithm
    • TPE Algorithm
      • orion.algo.tpe – Tree-structured Parzen Estimator Approach
  • Client helper functions
    • Commandline client
      • orion.client.cli – Helper function for returning results from script
    • Experiment client
      • orion.client.experiment – Experiment wrapper client
    • Helper function to insert new trials
      • orion.client.manual – Routines for manual interaction with database
    • orion.client – Python API
  • Core of Oríon
    • Worker and its components
      • orion.core.worker – Coordination of the optimization procedure
      • Experiment
        • orion.core.worker.experiment – Description of an optimization attempt
      • Trial
        • orion.core.worker.trial – Container class for Trial entity
      • Producer
        • orion.core.worker.producer – Produce and register samples to try
      • Consumer
        • orion.core.worker.consumer – Evaluate objective on a set of parameters
      • Primary algorithm
        • orion.core.worker.primary_algo – Sanitizing wrapper of main algorithm
      • Dimension transformations
        • orion.core.worker.transformer – Perform transformations on Dimensions
    • Experiment Version Control
      • orion.core.evc – Experiment Version Control System
      • Generic Tree
        • orion.core.evc.tree – Tree data structure for the experiment version control system
      • Experiment Node
        • orion.core.evc.experiment – Experiment node for EVC
      • Adapters for trials compatibility between experiments
        • orion.core.evc.adapters – Adapters to connect experiments within the EVC system
      • Conflicts detection and resolutions for creation of adapters
        • orion.core.evc.conflicts – Description and resolution of configuration conflicts
    • Input/Output
      • orion.core.io – Input/output functions for interaction with user’s script
      • Databases
        • MongoDB database
        • PickledDB database
        • EphemeralDB Database
        • orion.core.io.database – Wrappers for database frameworks
      • Configuration converter
        • orion.core.worker.convert – Parse and generate user script’s configuration
      • Space Builder
        • orion.core.io.space_builder – Create Space objects from configuration
      • Parsing of experiment configuration
        • orion.core.resolve_config – Configuration parsing and resolving
      • Experiment Builder
        • orion.core.io.experiment_builder – Create experiment from user options
      • Experiment Branch Builder
        • orion.core.io.experiment_branch_builder.py – Module offering an API to solve conflicts
      • Interactive commands
        • Branching Prompt
    • Command line
      • orion.core.cli – Functions that define console scripts
      • Base definitions for command line
        • orion.core.cli – Base class and function utilities for cli
      • hunt command
        • orion.core.cli.hunt – Module running the optimization command
      • insert command
        • orion.core.cli.insert – Module to insert new trials
      • init-only command
        • orion.core.cli.init_only – Module running the init_only command
      • db commands
        • orion.core.cli.db_main – Module containing database related operations
        • db test command
        • setup command
      • Arguments for handling of branching events
        • orion.core.cli.evc – Function utilities for evc in cli
    • Utilities
      • Format trials
        • orion.core.utils.format_trials – Utility functions for formatting data
      • Format terminal
        • orion.core.utils.format_terminal – Utility functions for formatting prints to terminal
      • orion.core.utils – Package-wide useful routines
  • Plotting
  • Storage Protocol
    • Base
      • orion.storage.base – Generic Storage Protocol
    • Legacy Database
      • orion.storage.legacy – Legacy storage
    • Track
      • orion.storage.track – Track Storage Protocol
orion
  • Docs »
  • Search
  • Edit on GitHub

© Copyright 2017-2020, Epistímio Revision 02003e52.

Built with Sphinx using a theme provided by Read the Docs.