33<i >An open source project from Data to AI Lab at MIT.</i >
44</p >
55
6-
6+ [ ![ PyPi ] ( https://img.shields.io/pypi/v/autobazaar.svg )] ( https://pypi.python.org/pypi/autobazaar )
77[ ![ Travis] ( https://travis-ci.org/HDI-Project/AutoBazaar.svg?branch=master )] ( https://travis-ci.org/HDI-Project/AutoBazaar )
8- [ ![ PyPi Shield] ( https://img.shields.io/pypi/v/autobazaar.svg )] ( https://pypi.python.org/pypi/autobazaar )
9-
8+ [ ![ Downloads] ( https://pepy.tech/badge/autobazaar )] ( https://pepy.tech/project/autobazaar )
109
1110# AutoBazaar
1211
13- - License: MIT
14- - Documentation: https://HDI-Project.github.io/AutoBazaar/
15- - Homepage: https://github.com/HDI-Project/AutoBazaar
12+ * License: [ MIT] ( https://github.com/HDI-Project/AutoBazaar/blob/master/LICENSE )
13+ * Documentation: https://HDI-Project.github.io/AutoBazaar/
14+ * Homepage: https://github.com/HDI-Project/AutoBazaar
15+ * Paper: https://arxiv.org/pdf/1905.08942.pdf
1616
17- # Overview
17+ ## Overview
1818
19- AutoBazaar is an AutoML system created to execute the experiments associated with the
20- [ The Machine Learning Bazaar Paper: Harnessing the ML Ecosystem for Effective System
21- Development] ( https://arxiv.org/pdf/1905.08942.pdf )
22- by the [ Human-Data Interaction (HDI) Project] ( https://hdi-dai.lids.mit.edu/ ) at LIDS, MIT.
19+ AutoBazaar is an AutoML system created using [ The Machine Learning Bazaar] ( https://arxiv.org/abs/1905.08942 ) ,
20+ a research project and framework for building ML and AutoML systems by the Data To AI Lab at MIT.
21+ See [ below] ( #citing-autobazaar ) for more references.
2322
2423It comes in the form of a python library which can be used directly inside any other python
2524project, as well as a CLI which allows searching for pipelines to solve a problem directly
@@ -35,68 +34,41 @@ Also, although it is not strictly required, the usage of a
3534[ virtualenv] ( https://virtualenv.pypa.io/en/latest/ ) is highly recommended in order to avoid
3635interfering with other software installed in the system where ** AutoBazaar** is run.
3736
38- These are the minimum commands needed to create a virtualenv using python3.6 for ** AutoBazaar** :
39-
40- ``` bash
41- pip install virtualenv
42- virtualenv -p $( which python3.6) autobazaar-venv
43- ```
44-
45- Afterwards, you have to execute this command to have the virtualenv activated:
46-
47- ``` bash
48- source autobazaar-venv/bin/activate
49- ```
50-
51- Remember about executing it every time you start a new console to work on ** AutoBazaar** !
52-
5337## Install with pip
5438
55- After creating the virtualenv and activating it, we recommend using
56- [ pip] ( https://pip.pypa.io/en/stable/ ) in order to install ** AutoBazaar ** :
39+ The easiest and recommended way to install ** AutoBazaar ** is using
40+ [ pip] ( https://pip.pypa.io/en/stable/ ) :
5741
5842``` bash
5943pip install autobazaar
6044```
6145
62- This will pull and install the latest stable release from [ PyPi] ( https://pypi.org/ ) .
63-
64- ## Install from source
65-
66- Alternatively, with your virtualenv activated, you can clone the repository and install it from
67- source by running ` make install ` on the ` stable ` branch:
68-
69- ``` bash
70- git clone
[email protected] :HDI-Project/AutoBazaar.git
71- cd AutoBazaar
72- git checkout stable
73- make install
74- ```
46+ This will pull and install the latest stable release from [ PyPI] ( https://pypi.org/ ) .
7547
76- For development, you can use ` make install-develop ` instead in order to install all
77- the required dependencies for testing and code linting .
48+ If you want to install from source or contribute to the project please read the
49+ [ Contributing Guide ] ( https://HDI-Project.github.io/AutoBazaar/contributing.html#get-started ) .
7850
7951# Data Format
8052
8153AutoBazaar works with datasets in the [ D3M Schema Format] ( https://github.com/mitll/d3m-schema )
8254as input.
8355
84- This dataset Schema , developed by MIT Lincoln Labs Laboratory for DARPA's Data Driven Discovery
85- of Models Program, requires the data to be in plainly readable formats such as CSV files or
56+ This dataset schema , developed by MIT Lincoln Labs Laboratory for DARPA's Data- Driven Discovery
57+ of Models (D3M) Program, requires the data to be in plainly readable formats such as CSV files or
8658JPG images, and to be set within a folder hierarchy alongside some metadata specifications
8759in JSON format, which include information about all the data contained, as well as the problem
8860that we are trying to solve.
8961
9062For more details about the schema and about how to format your data to be compliant with it,
91- please have a look at the [ Schema Documentation] ( https://github.com/mitll/d3m-schema/tree/master/documentation )
63+ refer to the [ Schema Documentation] ( https://github.com/mitll/d3m-schema/tree/master/documentation )
9264
9365As an example, you can browse some datasets which have been included in this repository for
9466demonstration purposes:
9567- [ 185_baseball] ( https://github.com/HDI-Project/AutoBazaar/tree/master/data/185_baseball ) : Single Table Regression
9668- [ 196_autoMpg] ( https://github.com/HDI-Project/AutoBazaar/tree/master/data/196_autoMpg ) : Single Table Classification
9769
98- Additionally, you can find a collection with ~ 500 datasets already formatted in the
99- [ d3m-data-dai S3 Bucket in AWS ] ( https://d3m-data-dai.s3.amazonaws.com/index.html ) .
70+ <!-- Additionally, you can find a collection with ~500 datasets already formatted in the
71+ [d3m-data-dai S3 Bucket](https://d3m-data-dai.s3.amazonaws.com/index.html).-->
10072
10173# Quickstart
10274
@@ -206,16 +178,16 @@ For more details about **AutoBazaar** and all its possibilities and features, pl
206178
207179# Credits
208180
209- AutoBazaar is an Open Source project from the Data to AI Lab at MIT built by the following team:
181+ AutoBazaar is an open-source project from the Data to AI Lab at MIT built by the following team:
210182
211- 212183213- 184+ 185+ 214186* Kalyan Veeramachaneni
< [email protected] > 215187
216188## Citing AutoBazaar
217189
218- If you use AutoBazaar for yor research, please consider citing the following paper (https://arxiv.org/pdf/1905.08942.pdf ):
190+ If you use AutoBazaar for your research, please consider citing the following paper (https://arxiv.org/pdf/1905.08942.pdf ):
219191
220192```
221193@article{smith2019mlbazaar,
0 commit comments