Skip to content

Commit eb4b80e

Browse files
committed
Update documentation for tabular regression task and installation instructions
1 parent b063820 commit eb4b80e

File tree

4 files changed

+21
-5
lines changed

4 files changed

+21
-5
lines changed

autoPyTorch/api/tabular_regression.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,11 @@ def search(
187187
configurations, similar to (...herepathtogreedy...).
188188
Additionally, the keyword 'greedy' is supported,
189189
which would use the default portfolio from
190-
`AutoPyTorch Tabular <https://arxiv.org/abs/2006.13799>`
190+
`AutoPyTorch Tabular <https://arxiv.org/abs/2006.13799>`.
191+
Although portfolio selection is supported for tabular
192+
regression, the portfolio has been built using
193+
classification datasets. We will update a portfolio
194+
to cover tabular regression datasets.
191195
192196
Returns:
193197
self

docs/api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,11 @@ Classification
1616
.. autoclass:: autoPyTorch.api.tabular_classification.TabularClassificationTask
1717
:members:
1818
:inherited-members: search, refit, predict, score
19+
20+
~~~~~~~~~~~~~~
21+
Regression
22+
~~~~~~~~~~~~~~
23+
24+
.. autoclass:: autoPyTorch.api.tabular_regression.TabularRegressionTask
25+
:members:
26+
:inherited-members: search, refit, predict, score

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@
6262
# Sphinx-gallery configuration.
6363

6464
# get current branch
65-
binder_branch = 'refactor_development'
65+
binder_branch = 'development'
6666
import autoPyTorch
6767
if "dev" in autoPyTorch.__version__:
68-
binder_branch = "refactor_development"
68+
binder_branch = "development"
6969

7070
sphinx_gallery_conf = {
7171
# path to the examples

docs/installation.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ System requirements
1111

1212
Auto-PyTorch has the following system requirements:
1313

14-
* Linux operating system (for example Ubuntu) `(get Linux here) <https://www.wikihow.com/Install-Linux>`_,
14+
* Linux operating system (for example Ubuntu), Mac OS X `(get Linux here) <https://www.wikihow.com/Install-Linux>`_,
1515
* Python (>=3.6) `(get Python here) <https://www.python.org/downloads/>`_.
1616
* C++ compiler (with C++11 supports) `(get GCC here) <https://www.tutorialspoint.com/How-to-Install-Cplusplus-Compiler-on-Linux>`_ and
1717
* SWIG (version 3.0.* is required; >=4.0.0 is not supported) `(get SWIG here) <http://www.swig.org/survey.html>`_.
@@ -23,7 +23,11 @@ Installing Auto-Pytorch
2323
2424
conda create -n autopytorch python=3.8
2525
conda activate autopytorch
26-
conda install gxx_linux-64 gcc_linux-64 swig
26+
For Linux:
27+
conda install gxx_linux-64 gcc_linux-64 swig
28+
For mac:
29+
conda install -c conda-forge clang_osx-64 clangxx_osx-64
30+
conda install -c anaconda swig
2731
cat requirements.txt | xargs -n 1 -L 1 pip install
2832
python setup.py install
2933

0 commit comments

Comments
 (0)