orion
v0.1.7

Installation Guide

  • Installation of Orion’s core
    • Via PyPI
    • Via Git
      • Recommended for users
      • Recommended for developers of Oríon
  • Setup Database
    • Local MongoDB Installation
      • Setup MongoDB without root access
      • Setup MongoDB with root access
    • Atlas MongoDB
    • Configuring Oríon’s Database
      • MongoDB
        • Arguments
      • PickledDB
        • Arguments
      • EphemeralDB
    • Test connection
    • Upgrade Database
  • Installation of plugins
    • Algorithms
      • Skopt algorithms
    • Database backend

User's Guide

  • Simple example
    • Installation and setup
    • Adapting the code for Oríon
    • Execution
    • Results
    • Notes
    • Debugging
      • Hunting Options
  • 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
  • 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
      • shape
    • Configuration
      • Commandline
      • Configuration file
    • Notes
      • Tranformations
        • Real
        • Integer
      • Conditional dependencies
    • References
  • Setup Algorithms
    • Selecting and Configuring
    • Included Algorithms
      • Random Search
        • Configuration
      • ASHA
        • Configuration
    • Algorithm Plugins
      • Bayesian Optimizer
        • Installation
        • Configuration
    • Parallel Strategies
      • NoParallelStrategy
      • StubParallelStrategy
      • MaxParallelStrategy
      • MeanParallelStrategy
  • Script Integration
    • Orion customization
      • user_script_config
      • working_dir
    • Command-line templating
    • Environment variables
  • Experiment Version Control
    • Source of conflicts
      • Iterative Results

Examples

  • Example with pytorch-cifar
  • Example with ikostrikov/pytorch-a2c-ppo-acktr
    • Intro
    • What to change
    • How to search for hyperparameters
  • Running on HPC
    • Parallel optimization using arrays
    • SSH tunnels
      • Notes for MongoDB
        • SSL
        • Replica Sets

Plugin development's Guide

  • How to setup and distribute a plugin
    • Setup
    • Distribution
  • Algorithms
    • Meet BaseAlgorithm
    • Implement Basic Algorithms
    • The Space Class
  • Database
  • Analysis and visualizations

Code Reference

  • 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
      • Experiment Version Control Tree Builder
        • orion.core.io.evc_builder – Builder of experiment version control tree
      • Interactive commands
        • Branching Prompt
    • Command lines
      • 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.test_db – Module to check if the DB worrks
        • 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
      • orion.core.utils – Package-wide useful routines
  • 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
    • Asynchronous Successive Halving Algorithm
  • Client helper functions
    • Helper function to insert new trials
      • orion.client.manual – Routines for manual interaction with database
    • orion.client – Helper function for returning results from script

Developer's Guide

  • Testing
    • Continuous Integration
    • Continuous Testing
    • Test
  • Document
  • Contribute
    • Coding and Repository Standards
    • Project Structure
    • Source Repository Structure
    • Fork and Pull Request
orion
  • Docs »
  • Overview: module code

All modules for which code is available

  • abc
  • orion.algo.base
  • orion.algo.random
  • orion.algo.space
  • orion.client
    • orion.client.manual
  • orion.core
    • orion.core.cli
      • orion.core.cli.base
      • orion.core.cli.db.test
      • orion.core.cli.db_main
      • orion.core.cli.evc
      • orion.core.cli.hunt
      • orion.core.cli.init_only
      • orion.core.cli.insert
    • orion.core.evc.adapters
    • orion.core.evc.conflicts
    • orion.core.evc.experiment
    • orion.core.evc.tree
    • orion.core.io.convert
    • orion.core.io.database
      • orion.core.io.database.ephemeraldb
      • orion.core.io.database.mongodb
      • orion.core.io.database.pickleddb
    • orion.core.io.evc_builder
    • orion.core.io.experiment_branch_builder
    • orion.core.io.experiment_builder
    • orion.core.io.interactive_commands.branching_prompt
    • orion.core.io.resolve_config
    • orion.core.io.space_builder
    • orion.core.utils
      • orion.core.utils.format_trials
    • orion.core.worker
      • orion.core.worker.consumer
      • orion.core.worker.experiment
      • orion.core.worker.primary_algo
      • orion.core.worker.producer
      • orion.core.worker.transformer
      • orion.core.worker.trial

© Copyright 2017-2019, Epistímio Revision 6d217af1.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v0.1.7
Versions
latest
stable
v0.1.7
v0.1.6
v0.1.5
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.