Merge pull request #6 from automl/development

Version 0.1

Author: René Sass

.DS_Store

@@ -0,0 +1,13 @@
+build/*
+*cache*
+!*cache.py
+!*caches.py
+docs/*
+__pycache__
+*.rdb
+examples/logs/SMAC
+examples/logs/BOHB
+smac3-output*
+.DS_Store
+pending
+__init__.pyc

.gitignore

@@ -0,0 +1,29 @@
+# 0.1
+
+## Features
+
+- Multi-Objective is supported with flexible objective objects.
+- Groups: If plugin supports groups, multiple runs can be used.
+- Automatically find converter: DeepCAVE scans the given directory and selects a suitable converter (if available).
+- Recorder: Record your runs and save them directly as DeepCAVE files.
+- Matplotlib mode: Alternatively, plugins can output Matplotlib rendered plots.
+
+
+## Plugins
+
+- StaticPlugin: Uses queue to process the result.
+- DynamicPlugin: Input changes are directly calculated.
+
+- Overview: Shows meta and statistics.
+- Configurations: Shows configuration space and best found configuration.
+- Cost over Time: Shows how the cost changes over time.
+- Configuration Cube: Shows configurations as points in a cube.
+- Individual Conditional Expectation / Partial Dependency Plots: Shows how individual instances behave.
+- fANOVA: Shows Hyperparameter Importance.
+
+
+## Converters
+
+- DeepCAVE
+- SMAC
+- BOHB (Beta)

CHANGELOG.md

@@ -1,20 +1,5 @@
-# Minimal makefile for Sphinx documentation
-#
+install:
+	pip install -r requirements.txt
 
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = docs
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+clean:
+	rm -rf cache