Skip to content

Commit e4a096d

Browse files
committed
make release-tag: Merge branch 'master' into stable
2 parents 3fea85a + e739c46 commit e4a096d

31 files changed

+613
-353
lines changed

.dockerignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
data/
2+
input/
3+
input_dir/
4+
output/
5+
docs/
6+
tests/
7+
logs/
8+
static/
9+
notebooks/
10+
.tox/
11+
.git/

.editorconfig

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.py]
14+
max_line_length = 99
15+
16+
[LICENSE]
17+
insert_final_newline = false
18+
19+
[Makefile]
20+
indent_style = tab

.github/ISSUE_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* AutoBazaar version:
2+
* Python version:
3+
* Operating System (`python -c 'import platform;print(platform.platform())'`):
4+
5+
### Description
6+
7+
Describe what you were trying to get done.
8+
Tell us what happened, what went wrong, and what you expected to happen.
9+
10+
### What I Did
11+
12+
```
13+
Paste the command(s) you ran and the output.
14+
If there was a crash, please include the traceback here.
15+
```

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,6 @@ input
119119
data
120120
compressed
121121
notebooks
122+
123+
.bak
124+
mongodb_config.json

Dockerfile

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
FROM python:3.6-buster
2+
3+
RUN mkdir /autobazaar && \
4+
mkdir /abz && \
5+
ln -s /input /abz/input && \
6+
ln -s /output /abz/output
7+
8+
# Copy code
9+
COPY setup.py README.md HISTORY.md MANIFEST.in /autobazaar/
10+
11+
# Install project
12+
RUN pip3 install -e /autobazaar && pip install ipdb
13+
14+
COPY autobazaar /autobazaar/autobazaar
15+
16+
WORKDIR /abz
17+
18+
CMD ["echo", "Usage: docker run -ti -u$UID -v $(pwd):/abz mlbazaar/autobazaar abz OPTIONS"]

HISTORY.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
11
# History
22

3+
## 0.2.0 - 2019-11-26
4+
5+
Second Release:
6+
7+
* Improved CLI interface
8+
* Improved Dataset support
9+
* New Docker image
10+
* Newer dependencies
11+
12+
This is the version used to generate the results explained in the third version of [
13+
The Machine Learning Bazaar Paper](https://arxiv.org/abs/1905.08942v3)
14+
315
## 0.1.0 - 2019-06-24
416

517
First Release.
618

719
This is a slightly cleaned up version of the software used to generate the results
8-
explained in [The Machine Learning Bazaar Paper](https://arxiv.org/pdf/1905.08942.pdf)
20+
explained in the first version of [The Machine Learning Bazaar Paper](
21+
https://arxiv.org/abs/1905.08942v1)

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ fix-lint: ## fix lint issues using autoflake, autopep8, and isort
105105

106106
.PHONY: test-all
107107
test-all: ## run tests on every Python version with tox
108-
tox
108+
tox -r
109109

110110
.PHONY: coverage
111111
coverage: ## check code coverage quickly with the default Python

README.md

Lines changed: 24 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,22 @@
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

2423
It comes in the form of a python library which can be used directly inside any other python
2524
project, 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
3635
interfering 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
5943
pip 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

8153
AutoBazaar works with datasets in the [D3M Schema Format](https://github.com/mitll/d3m-schema)
8254
as 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
8658
JPG images, and to be set within a folder hierarchy alongside some metadata specifications
8759
in JSON format, which include information about all the data contained, as well as the problem
8860
that we are trying to solve.
8961

9062
For 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

9365
As an example, you can browse some datasets which have been included in this repository for
9466
demonstration 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-
* Carles Sala <[email protected]>
212183
* Micah Smith <[email protected]>
213-
* Max Kanter <[email protected]>
184+
* Carles Sala <[email protected]>
185+
* Max Kanter <[email protected]>
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,

autobazaar/__init__.py

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,35 @@
99
by the [Human-Data Interaction (HDI) Project](https://hdi-dai.lids.mit.edu/) at LIDS, MIT.
1010
1111
* Free software: MIT license
12-
* Documentation: https://HDI-Project.github.io/MLBlocks
12+
* Documentation: https://HDI-Project.github.io/AutoBazaar
1313
"""
14+
import os
15+
16+
import git
1417

1518
__author__ = 'MIT Data To AI Lab'
1619
__copyright__ = 'Copyright (c) 2019, MIT Data To AI Lab'
1720
__email__ = '[email protected]'
1821
__license__ = 'MIT'
19-
__version__ = '0.1.0'
22+
__version__ = '0.2.0-dev'
23+
24+
25+
def _get_commit():
26+
try:
27+
base_path = os.path.dirname(__file__)
28+
repo = git.Repo(base_path, search_parent_directories=True)
29+
commit = repo.commit().hexsha[0:7]
30+
if repo.is_dirty(untracked_files=False):
31+
commit += '*'
32+
33+
return commit
34+
except git.InvalidGitRepositoryError:
35+
return None
36+
37+
38+
def get_version():
39+
commit = _get_commit()
40+
if commit:
41+
return '{} - {}'.format(__version__, commit)
42+
43+
return __version__

0 commit comments

Comments
 (0)