diff --git a/README.md b/README.md index c092ac8..92738e0 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,15 @@ The easiest way is to install using pip: pip install oboe ``` +Alternatively, if you want to customize the source code, you may install in the editable mode by first `git clone` this respository, and then do + +``` +pip install -e . +``` + +in the cloned directory. + + #### Dependencies with verified versions The Oboe systems work on Python 3.7 or later. The following libraries are required. The listed versions are the versions that are verified to work. Older versions may work but are not guaranteed. @@ -37,10 +46,10 @@ The Oboe systems work on Python 3.7 or later. The following libraries are requir For more detailed examples, please refer to the Jupyter notebooks in the `example` folder. A basic classification example: ```python -method = 'Oboe' # 'Oboe' or 'TensorOboe' +method = 'Oboe' # 'Oboe' or 'TensorOboe' problem_type = 'classification' -from oboe import AutoLearner, error +from oboe import AutoLearner, error # This may take around 15 seconds at first run. import numpy as np from sklearn.datasets import load_iris diff --git a/setup.py b/setup.py index ecf400a..72af5a2 100644 --- a/setup.py +++ b/setup.py @@ -3,6 +3,18 @@ with open("README.md", "r", encoding="utf-8") as fh: long_description = fh.read() +def package_files(directory): + """ + Recursively find all files in a (sub)directory. + Source: https://stackoverflow.com/a/36693250 + """ + paths = [] + for (path, directories, filenames) in os.walk(directory): + for filename in filenames: + paths.append(os.path.join('..', path, filename)) + return paths + + install_requires = [ "numpy>=1.16.4", "scipy>=1.4.1", @@ -33,6 +45,7 @@ "Operating System :: OS Independent", ], packages=setuptools.find_packages(), + package_data={'': package_files('oboe/defaults')}, install_requires=install_requires, python_requires=">=3.7", ) \ No newline at end of file