Skip to content

Commit

Permalink
MAINT move to github.io for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mfeurer committed May 2, 2016
1 parent 2591651 commit e1ba8a5
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 76 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ env:
matrix:
- DISTRIB="conda" PYTHON_VERSION="2.7"
- DISTRIB="conda" PYTHON_VERSION="3.4" COVERAGE="true"
- DISTRIB="conda" PYTHON_VERSION="3.5"

install:
# Necessary for random forest
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,16 @@

auto-sklearn is an automated machine learning toolkit and a drop-in replacement for a scikit-learn estimator.

Find the documentation [here](http://auto-sklearn.readthedocs.org)
Find the documentation [here](http://automl.github.io/auto-sklearn/)

Status for master branch:

[![Build Status](https://travis-ci.org/automl/auto-sklearn.svg?branch=master)](https://travis-ci.org/automl/auto-sklearn)
[![Code Health](https://landscape.io/github/automl/auto-sklearn/master/landscape.png)](https://landscape.io/github/automl/auto-sklearn/master)
[![Documentation Status](https://readthedocs.org/projects/auto-sklearn/badge/?version=master)](http://auto-sklearn.readthedocs.org/en/master/)
[![Coverage Status](https://coveralls.io/repos/automl/auto-sklearn/badge.svg?branch=master&service=github)](https://coveralls.io/github/automl/auto-sklearn?branch=master)

Status for development branch

[![Build Status](https://travis-ci.org/automl/auto-sklearn.svg?branch=development)](https://travis-ci.org/automl/auto-sklearn)
[![Code Health](https://landscape.io/github/automl/auto-sklearn/development/landscape.png)](https://landscape.io/github/automl/auto-sklearn/development)
[![Documentation Status](https://readthedocs.org/projects/auto-sklearn/badge/?version=development)](http://auto-sklearn.readthedocs.org/en/development/)
[![Coverage Status](https://coveralls.io/repos/automl/auto-sklearn/badge.svg?branch=development&service=github)](https://coveralls.io/github/automl/auto-sklearn?branch=development)
68 changes: 20 additions & 48 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ replacement for a scikit-learn estimator:
*auto-sklearn* frees a machine learning user from algorithm selection and
hyperparameter tuning. It leverages recent advantages in *Bayesian
optimization*, *meta-learning* and *ensemble construction*. Learn more about
the technology behind *auto-sklearn* by reading a paper we just published at
the technology behind *auto-sklearn* by reading this paper published at
the `NIPS 2015 <http://papers.nips.cc/paper/5872-efficient-and-robust-automated-machine-learning.pdf>`_
.

Expand Down Expand Up @@ -50,21 +50,15 @@ This will run for one hour should result in an accuracy above 0.98.

Installation
************
**Prerequisities**: *auto-sklearn* is written in python (2.7) and was developed
**Prerequisities**: *auto-sklearn* is written in python and was developed
with Ubuntu. It should run on other Linux distributions, but won't work on a MAC
or on a windows PC. It requires scikit-learn 0.16.1, which in turn requires
numpy and scipy.

*auto-sklearn* has at least one dependency, which is not yet automatically
resolved:

* `HPOlibConfigSpace <https://github.com/automl/HPOlibConfigSpace>`_
or on a windows PC. It is built around scikit-learn 0.17.1

Please install all dependencies manually with:

.. code:: bash
pip install -r https://raw.githubusercontent.com/automl/auto-sklearn/master/requ.txt
pip install -r https://raw.githubusercontent.com/automl/auto-sklearn/master/requirements.txt
Then install *auto-sklearn*

Expand All @@ -74,9 +68,7 @@ Then install *auto-sklearn*
We recommend installing *auto-sklearn* into a `virtual environment
<http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_ or into an
`anaconda environment <https://www.continuum.io/downloads>`_ because we have
seen strange things happening when installing it using
:bash:`python setup.py --user`.
`anaconda environment <https://www.continuum.io/downloads>`_..

Manual
******
Expand All @@ -90,7 +82,7 @@ License
*******
*auto-sklearn* is licensed the same way as *scikit-learn*,
namely the 3-clause BSD license. The subprojects it uses, most notably SMAC,
may have different licenses.
can have different licenses.

Contributing
************
Expand All @@ -109,24 +101,19 @@ When developing new features, please create a new branch from the development
branch. Prior to submitting a pull request, make sure that all tests are
still passing.

Features under development
--------------------------
* support for arff files
* support for scikit-learn 0.17
* python 3 compability
* command line interface

A short guide to the code
-------------------------
* `automl.py`: main class which controls the workflow.
* `estimators.py`: wraps a scikit-learn interface around automl.py.
* `cli`: command line interface to the machine learning algorithm which is
used internally by SMAC.
* `data`: code to read and store machine learning datasets.
* `evaluation`: classes to control the execution of machine learning,
algorithms and resampling of the data.
* `metrics`: contains metrics which can be optimized.
* `util`: several utilityy functions.
..
A short guide to the code
-------------------------
* `automl.py`: main class which controls the workflow.
* `estimators.py`: wraps a scikit-learn interface around automl.py.
* `cli`: command line interface to the machine learning algorithm which is
used internally by SMAC.
* `data`: code to read and store machine learning datasets.
* `evaluation`: classes to control the execution of machine learning,
algorithms and resampling of the data.
* `metrics`: contains metrics which can be optimized.
* `util`: several utilityy functions.

Contributors
************
Expand All @@ -140,19 +127,4 @@ Contributors
* Farooq Ahmed Zuberi
* Frank Hutter
* Alexander Sapronov

..
Welcome to AutoSklearn's documentation!
=======================================
Contents:

.. toctree::
:maxdepth: 2

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* Anatolii Domashnev
25 changes: 0 additions & 25 deletions requ.txt

This file was deleted.

25 changes: 25 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
unittest2
setuptools
mock
nose

numpy>=1.9.0
scipy>=0.14.1

scikit-learn==0.17.1

lockfile
joblib
psutil
pyyaml
six
ConfigArgParse
liac-arff
pandas
Cython
xgboost

ConfigSpace
pynisher>=0.4
pyrfr
smac

0 comments on commit e1ba8a5

Please sign in to comment.