Refactoring base dataset

.binder/apt.txt

@@ -0,0 +1,2 @@
+build-essential
+swig

.binder/postBuild

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+set -e
+
+python -m pip install .[docs,examples]
+
+# Taken from https://github.com/scikit-learn/scikit-learn/blob/22cd233e1932457947e9994285dc7fd4e93881e4/.binder/postBuild
+# under BSD3 license, copyright the scikit-learn contributors
+
+# This script is called in a binder context. When this script is called, we are
+# inside a git checkout of the automl/Auto-PyTorch repo. This script
+# generates notebooks from the Auto-PyTorch python examples.
+
+if [[ ! -f /.dockerenv ]]; then
+    echo "This script was written for repo2docker and is supposed to run inside a docker container."
+    echo "Exiting because this script can delete data if run outside of a docker container."
+    exit 1
+fi
+
+# Copy content we need from the Auto-PyTorch repo
+TMP_CONTENT_DIR=/tmp/Auto-PyTorch
+mkdir -p $TMP_CONTENT_DIR
+cp -r examples .binder $TMP_CONTENT_DIR
+# delete everything in current directory including dot files and dot folders
+find . -delete
+
+# Generate notebooks and remove other files from examples folder
+GENERATED_NOTEBOOKS_DIR=examples
+cp -r $TMP_CONTENT_DIR/examples $GENERATED_NOTEBOOKS_DIR
+
+find $GENERATED_NOTEBOOKS_DIR -name 'example_*.py' -exec sphx_glr_python_to_jupyter.py '{}' +
+# Keep __init__.py and custom_metrics.py
+NON_NOTEBOOKS=$(find $GENERATED_NOTEBOOKS_DIR -type f | grep -v '\.ipynb' | grep -v 'init' | grep -v 'custom_metrics')
+rm -f $NON_NOTEBOOKS
+
+# Modify path to be consistent by the path given by sphinx-gallery
+mkdir notebooks
+mv $GENERATED_NOTEBOOKS_DIR notebooks/
+
+# Put the .binder folder back (may be useful for debugging purposes)
+mv $TMP_CONTENT_DIR/.binder .
+# Final clean up
+rm -rf $TMP_CONTENT_DIR

.binder/requirements.txt

@@ -0,0 +1 @@
+-r ../requirements.txt

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: Docs
+on: [pull_request, push]
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        pip install -e .[docs,examples]
+    - name: Make docs
+      run: |
+        cd docs
+        make html
+    - name: Pull latest gh-pages
+      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
+      run: |
+        cd ..
+        git clone https://github.com/automl/Auto-PyTorch.git --branch gh-pages --single-branch gh-pages
+    - name: Copy new doc into gh-pages
+      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
+      run: |
+        branch_name=${GITHUB_REF##*/}
+        cd ../gh-pages
+        rm -rf $branch_name
+        cp -r ../Auto-PyTorch/docs/build/html $branch_name
+    - name: Push to gh-pages
+      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
+      run: |
+        last_commit=$(git log --pretty=format:"%an: %s")
+        cd ../gh-pages
+        branch_name=${GITHUB_REF##*/}
+        git add $branch_name/
+        git config --global user.name 'Github Actions'
+        git config --global user.email '[email protected]'
+        git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+        git commit -am "$last_commit"
+        git push

.github/workflows/pytest.yml

@@ -29,7 +29,7 @@ jobs:
     - name: Run tests
       run: |
         if [ ${{ matrix.code-cov }} ]; then codecov='--cov=autoPyTorch --cov-report=xml'; fi
-        python -m pytest -n 2 --timeout=600 --timeout-method=thread --dist load test -sv $codecov
+        python -m pytest --durations=20 --timeout=300 --timeout-method=thread -v $codecov test
     - name: Check for files left behind by test
       if: ${{ always() }}
       run: |

README.md

@@ -2,33 +2,36 @@
 
 Copyright (C) 2019  [AutoML Group Freiburg](http://www.automl.org/)
 
-This an alpha version of Auto-PyTorch.
-So far, Auto-PyTorch supports tabular data (classification, regression), image data (classification) and time-series data (TODO).
+This an alpha version of Auto-PyTorch with improved API.
+So far, Auto-PyTorch supports tabular data (classification, regression).
+We plan to enable image data and time-series data.
+
+
+Find the documentation [here](https://automl.github.io/Auto-PyTorch/refactor_development)
 
 
 ## Installation
 
 ### Pip
-```sh
-$ pip install autoPyTorch
-```
 
-### Manually
+We recommend using Anaconda for developing as follows:
+
 ```sh
-$ cd install/path
-$ git clone https://github.com/automl/Auto-PyTorch.git
-$ cd Auto-PyTorch
-$ cat requirements.txt | xargs -n 1 -L 1 pip install
-$ python setup.py install
-```
+# Following commands assume the user is in a cloned directory of Auto-Pytorch
+conda create -n autopytorch python=3.8
+conda activate autopytorch
+conda install gxx_linux-64 gcc_linux-64 swig
+cat requirements.txt | xargs -n 1 -L 1 pip install
+python setup.py install
 
+```
 
 ## Contributing
 
 If you want to contribute to Auto-PyTorch, clone the repository and checkout our current development branch
 
 ```sh
-$ git checkout development
+$ git checkout refactor_development
 ```
 
 

autoPyTorch/__init__.py

@@ -0,0 +1 @@
+from autoPyTorch.__version__ import __version__  # noqa (imported but unused)

autoPyTorch/__version__.py

@@ -0,0 +1,4 @@
+"""Version information."""
+
+# The following line *must* be the last in the module, exactly as formatted:
+__version__ = "0.0.3"