orion
v0.2.6

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
      • Grid Search
        • Configuration
      • Hyperband
        • Configuration
      • ASHA
        • Configuration
      • BOHB
        • Configuration
      • DEHB
        • Configuration
      • Population Based Training (PBT)
        • Configuration
      • Population Based Bandits (PB2)
        • Configuration
      • TPE
        • Configuration
      • Ax
        • Configuration
      • Evolution-ES
        • Configuration
      • MOFA
        • Configuration
      • Nevergrad
      • HEBO
        • Configuration
    • Algorithm Plugins
      • Scikit-Optimize
      • Robust Bayesian Optimization
    • Parallel Strategies
      • NoParallelStrategy
      • StubParallelStrategy
      • MaxParallelStrategy
      • MeanParallelStrategy
      • StatusBasedParallelStrategy
  • 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
      • Transformations
        • 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 information about experiments
        • The --name argument
        • The --version argument
    • Library API
      • Results
      • Iterative Results with EVC
    • Web API
      • Authentication
      • Runtime
      • Experiments
      • Trials
      • Plots
      • Errors
  • Visualizations
    • Examples
      • Regret curves
      • Parallel Coordinates
        • Special cases
      • Local Parameter Importance
        • Special cases
      • Partial Dependencies
        • Options
        • Special cases
    • How-tos
      • How-tos
        • How to plot.
        • How to save
        • How to share with chart studio
  • Benchmark
  • 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
      • release algorithm lock
      • upgrade Upgrade database scheme
    • Python APIs
      • ExperimentClient
        • to_pandas
        • 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
      • algorithms
      • strategy
    • Worker
      • n_workers
      • pool_size
      • executor
      • executor_configuration
      • heartbeat
      • max_trials
      • max_broken
      • reservation_timeout
      • max_idle_time
      • interrupt_signal_code
      • user_script_config
    • Experiment Version Control
      • enable
      • auto_resolution
      • manual_resolution
      • non_monitored_arguments
      • ignore_code_changes
      • algorithm_change
      • code_change_type
      • cli_change_type
      • config_change_type
      • orion_version_change
  • Parallel Workers
    • Executor backends
      • Joblib
      • Dask

Tutorials

  • Scikit-learn
    • Sample script
    • Enter Orion
      • Updating the script
      • Updating the script call
    • Viewing the results
  • Python API basics
    • Further readings
  • PyTorch MNIST
    • Installation and setup
    • Adapting the code for Oríon
    • Execution
    • Results
    • Notes
    • Debugging
  • Checkpointing trials
    • With command line
    • Training code
    • HPO code
    • Analysis
  • Scaling workers
    • Joblib
    • Dask
  • Running on HPC
    • Parallel optimization using arrays
    • SSH tunnels
      • Notes for MongoDB
        • SSL
        • Replica Sets
  • PyTorch A2C PPO ACKTR
    • Intro
    • What to change
    • How to search for hyperparameters

Plugins

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

API Reference

  • Algorithm modules
    • Space search
      • Search space of optimization problems
    • Base definition of algorithms
    • Random Search Algorithm
      • Random sampler as optimization algorithm
    • Grid Search Algorithm
      • Grid Search
    • Hyperband Algorithm
      • A Novel Bandit-Based Approach to Hyperparameter Optimization
    • Asynchronous Successive Halving Algorithm
      • Asynchronous Successive Halving Algorithm
    • DEHB
    • BOHB
      • orion.algo.bohb – BOHB
    • Population Based Training
      • Population Based Training
      • LineageNode
      • Lineages
      • Exploit classes for Population Based Training
        • BaseExploit
        • PipelineExploit
        • TruncateExploit
        • BacktrackExploit
      • Explore classes for Population Based Training
        • BaseExplore
        • PipelineExplore
        • PerturbExplore
        • ResampleExplore
    • Population Based Bandits
      • Population Based Bandits
      • PB2 Utils
    • TPE Algorithm
      • Tree-structured Parzen Estimator Approach
    • Ax
      • orion.algo.axoptimizer – Ax Wrapper
    • MOFA Algorithm
      • orion.algo.mofa.mofa – MOFA
    • Nevergrad
      • Nevergrad Optimizer
    • Parallel Strategy
      • Parallel Strategies
    • Registries
    • HEBO
  • Analysis
    • Base utils
      • Base tools to compute diverse analysis
    • Local Parameter Importance
      • Provide tools to calculate Local Parameter Importance
    • Partial Dependencies
      • Tools to compute Partial Dependency
    • Regret
      • Provide tools to calculate regret
    • Provides HPO analysis tools
  • Benchmark modules
    • Benchmark definition
    • Benchmark Client
      • Benchmark client
    • Task modules
      • Benchmark Tasks definition
      • Base definition of tasks
        • Base definition of Task
      • Branin
        • Task for Branin Function
      • CarromTable
        • Task for CarromTable Function
      • EggHolder
        • Task for EggHolder Function
      • RosenBrock
        • Task for RosenBrock Function
      • Forrester
      • Profet Task modules
        • Base definition of a Profet task
        • Utilities for training the Profet meta-model
    • Assessment modules
      • Benchmark Assessments definition
      • Base definition of assessments
        • Base definition of Assessment
      • Average Rank
        • Average Rank Assessment
      • Average Result
        • Average Rank Assessment
      • Average Rank
        • Parallel Advantage Assessment
  • Client helper functions
    • Commandline client
      • Helper function for returning results from script
    • Experiment client
      • Experiment wrapper client
    • Helper function to insert new trials
      • Routines for manual interaction with database
    • Python API
  • Core of Oríon
    • Worker and its components
      • Consumer
        • Evaluate objective on a set of parameters
      • Experiment
        • Description of an optimization attempt
      • Primary algorithm
        • Sanitizing wrapper of main algorithm
      • Producer
        • Produce and register samples to try
      • Dimension transformations
        • Perform transformations on Dimensions
      • Trial
        • Container class for Trial entity
      • Trial Pacemaker
        • Trial Pacemaker
    • Experiment Version Control
      • Experiment Version Control System
      • Experiment Node
        • Experiment node for EVC
      • Adapters for trials compatibility between experiments
        • Adapters to connect experiments within the EVC system
      • Conflicts detection and resolutions for creation of adapters
        • Description and resolution of configuration conflicts
    • Input/Output
      • Input/output functions for interaction with user’s script
      • Databases
        • MongoDB database
        • PickledDB database
        • EphemeralDB Database
        • Wrappers for database frameworks
      • Configuration converter
        • Parse and generate user script’s configuration
      • Space Builder
        • Create Space objects from configuration
      • Parsing of experiment configuration
        • Configuration parsing and resolving
      • Experiment Builder
        • Create experiment from user options
      • Experiment Branch Builder
        • Module offering an API to solve conflicts
      • Interactive commands
        • Branching Prompt
    • Command line
      • Functions that define console scripts
      • Base definitions for command line
        • Base class and function utilities for cli
      • hunt command
        • Module running the optimization command
      • insert command
        • Module to insert new trials
      • init-only command
        • Module running the init_only command
      • db commands
        • Module containing database related operations
        • setup command
        • db test command
        • db upgrade command
        • db rm command
        • db set command
        • db release command
      • Arguments for handling of branching events
        • Function utilities for evc in cli
    • Utilities
      • Exceptions
        • Custom exceptions for Oríon
      • Format trials
        • Utility functions for formatting data
      • Format terminal
        • Utility functions for formatting prints to terminal
      • Singleton
        • Singleton helpers and boilerplate
      • Generic Tree
        • Tree data structure
      • Package-wide useful routines
  • Executor modules
    • Base
      • Base Executor
    • Dask Executor
    • Joblib Executor
    • Base
      • Executor without parallelism for debugging
    • Joblib Executor
  • Plotting
    • Plotting Base Backend
      • Provides public plotting API
    • Plotly backend
      • Plotly backend for plotting methods
  • Storage Protocol
    • Base
      • Generic Storage Protocol
        • Examples
        • Notes
    • Legacy Database
      • Legacy storage
    • Track
      • Track Storage Protocol
  • Testing
    • Algorithms
    • Plotting
      • Plotting testing support module
    • Space
    • State (storage)
      • Mocks Oríon’s runtime
    • Common testing support module

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
    • Writing examples
    • Building documentation
  • Continuous Integration
  • Releasing
    • Creating a release candidate
    • Making the release
    • After the release
orion
  • Docs »
  • Plotting
  • Edit on GitHub
Next Previous

Plotting¶

Modules

  • Plotting Base Backend
  • Plotly backend
Next Previous

© Copyright 2017-2022, Epistímio Revision 2b07a1d4.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v0.2.6
Versions
latest
stable
v0.2.6
v0.2.5
v0.2.4.post1
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.1.17
v0.1.16
v0.1.15
v0.1.14
v0.1.13
v0.1.12
v0.1.11
v0.1.10
v0.1.9
v0.1.8
v0.1.7
doc-viz
doc-external_algo_plugin
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.