Sacred

++++++++++++++++++
Last release to support Python 2.7.

* Feature: major improvements to error reporting (thanks thequilo)
* Feature: added print_named_configs command
* Feature: added option to add metadata to artifacts (thanks jarnoRFB)
* Feature: content type detection for artifacts (thanks jarnoRFB)
* Feature: automatic seeding for pytorch (thanks srossi93)
* Feature: add proxy support to telegram observer (thanks brickerino)
* Feature: made MongoObserver fail dump dir configurable (thanks jarnoRFB)
* Feature: added queue-based observer that better handles unreliable connections (thanks jarnoRFB)
* Bugfix: some fixes to stdout capturing
* Bugfix: FileStorageObserver now creates directories only when starting a run (329; thanks thomasjpfan)
* Bugfix: Fixed config_hooks (326; thanks thomasjpfan)
* Bugfix: Fixed a crash when overwriting non-dict config entries with dicts (325; thanks thomasjpfan)
* Bugfix: fixed problem with running in conda environment (341)
* Bugfix: numpy aware config change detection (344)
* Bugfix: allow dependencies to be compiled libraries (thanks jnphilipp)
* Bugfix: output colorization now works on 256 and 16 color terminals (thanks bosr)
* Bugfix: fixed problem with tinydb observer logging (327; thanks michalgregor)
* Bugfix: ignore folders that have the same name as a named_config (thanks boeddeker)
* Bugfix: setup no longer overwrites pre-configured root logger (thanks thequilo)
* Bugfix: compatibility with tensorflow 2.0 (thanks tarik, gabrieldemarmiesse)
* Bugfix: fixed exception when no tee is available for stdout capturing (thanks greg-farquhar)
* Bugfix: fixed concurrency issue with FileStorageObserver (thanks dekuenstle)

++++++++++++++++++
* Bugfix: fixed problem with postgres backend of SQLObserver (thanks bensternlieb)
* Bugfix: fixed a problem with the interaction of ingredients and named configs
* Feature: added metrics logging to the FileStorageObserver (thanks ummavi)

++++++++++++++++++
* Feature: support custom experiment base directory (thanks anibali)
* Feature: added option to pass existing MongoClient to MongoObserver (thanks rueberger)
* Feature: allow setting the config docstring from named configs
* Feature: added py-cpuinfo as fallback for gathering CPU information (thanks serv-inc)
* Feature: added support for _log argument in config function
* Bugfix: stacktrace filtering now correctly handles chained exceptions (thanks kamo-naoyuki)
* Bugfix: resolved issue with stdout capturing sometimes loosing the last few lines
* Bugfix: fixed the overwrite option of MongoObserver
* Bugfix: fixed a problem with the heartbeat sometimes not ending
* Bugfix: fixed an error with running in interactive mode
* Bugfix: added a check for non-unique ingredient paths (thanks boeddeker)
* Bugfix: fixed several problems with utf-8 decoding (thanks LukasDrude, wjp)
* Bugfix: fixed nesting structure of _config (thanks boeddeker)
* Bugfix: fixed crash when using git integration with empty repository (thanks ramon-oliveira)
* Bugfix: fixed a crash with first run using sqlite backend
* Bugfix: fixed several problem with the tests (thanks thomasjpfan)
* Bugfix: fixed racing condition in FileStorageObserver (thanks boeddeker)
* Bugfix: fixed problem with overwriting named configs of ingredients (thanks pimdh)
* Bugfix: removed deprecated call to inspect.getargspec()
* Bugfix: fixed problem with empty dictionaries disappearing from config updates and named configs (thanks TomVeniat)
* Bugfix: fixed problem with commandline parsing when program name contained spaces
* Bugfix: loglevl option is now taken into account for config related warnings
* Bugfix: properly handle numpy types in metrics logging

++++++++++++++++++
* API Change: added host_info to queued_event
* Feature: improved and configurable dependency discovery system
* Feature: improved and configurable source-file discovery system
* Feature: better error messages for missing or misspelled commands
* Feature: -m flag now supports passing an id for a run to overwrite
* Feature: allow captured functions to be called outside of a run (thanks berleon)
* Bugfix: fixed issue with telegram imports (thanks millawell)

++++++++++++++++++
* Refactor: lazy importing of many optional dependencies
* Feature: added metrics API for adding live monitoring information to the MongoDB
* Feature: added integration with tensorflow for automatic capturing of LogWriter paths
* Feature: set seed of tensorflow if it is imported
* Feature: named_configs can now affect the config of ingredients
* Bugfix: failed runs now return with exit code 1 by default
* Bugfix: fixed a problem with UTF-8 symbols in stdout
* Bugfix: fixed a threading issue with the SQLObserver
* Bugfix: fixed a problem with consecutive ids in the SQLObserver
* Bugfix: heartbeat events now also serialize the intermediate results
* Bugfix: reapeatedly calling run from python with an option for adding an
observer, no longer duplicates observers
* Bugfix: fixed a problem where **kwargs of captured functions might be modified
* Bugfix: fixed an encoding problem with the FileStorageObserver
* Bugfix: fixed an issue where determining the version of some packages would crash
* Bugfix: fixed handling of relative filepaths in the SQLObserver and the TinyDBObserver

++++++++++++++++++
* Feature: host info now contains information about NVIDIA GPUs (if available)
* Feature: git integration: sacred now collects info about the git repository
of the experiment (if available and if gitpython is installed)
* Feature: new ``--enforce-clean`` flag that cancels a run if the
git repository is dirty
* Feature: added new TinyDbObserver and TinyDbReader (thanks to MrKriss)
* Feature: added new SqlObserver
* Feature: added new FileStorageObserver
* Feature: added new SlackObserver
* Feature: added new TelegramObserver (thanks to black-puppydog)
* Feature: added save_config command
* Feature: added queue flag to just queue a run instead of executing it
* Feature: added TimeoutInterrupt to signal that a run timed out
* Feature: experiments can now be run in Jupyter notebook, but will fail with
an error by default, which can be deactivated using interactive=True
* Feature: allow to pass unparsed commandline string to ``ex.run_commandline``.
* Feature: improved stdout/stderr capturing: it now also collects non-python
outputs and logging.
* Feature: observers now share the id of a run and it is available during
runtime as ``run._id``.
* Feature: new ``--print_config`` flag to always print config first
* Feature: added sacred.SETTINGS as a place to configure some of the behaviour
* Feature: ConfigScopes now extract docstrings and line comments and display
them when calling ``print_config``
* Feature: observers are now run in order of priority (settable)
* Feature: new ``--name=NAME`` option to set the name of experiment for this run
* Feature: the heartbeat event now stores an intermediate result (if set).
* Feature: ENVIRONMENT variables can be captured as part of host info.
* Feature: sped up the applying_lines_and_backfeeds stdout filter. (thanks to remss)
* Feature: adding resources by name (thanks to d4nst)
* API Change: all times are now in UTC
* API Change: significantly changed the mongoDB layout
* API Change: MongoObserver and FileStorageObserver now use consecutive
integers as _id
* API Change: the name passed to Experiment is now optional and defaults to the
name of the file in which it was instantiated.
(The name is still required for interactive mode)
* API Change: Artifacts can now be named, and are stored by the observers under
that name.
* API Change: Experiment.run_command is deprecated in favor of run, which now
also takes a command_name parameter.
* API Change: Experiment.run now takes an options argument to add
commandline-options also from python.
* API Change: Experiment.get_experiment_info() now returns source-names as
relative paths and includes a separate base_dir entry
* Dependencies: Migrated from six to future, to avoid conflicts with old
preinstalled versions of six.
* Bugfix: fixed a problem when trying to set the loglevel to DEBUG
* Bugfix: type conversions from None to some other type are now correctly ignored
* Bugfix: fixed a problem with stdout capturing breaking tools that access
certain attributes of ``sys.stdout`` or ``sys.stderr``.
* Bugfix: main, automain, command and capture now support functions with
Python3 style annotations.
* Bugfix: fixed a problem with config-docs from ingredients not being propagated
* Bugfix: fixed setting seed to 0 being ignored