Skip to content

Commit

Permalink
Docs (#902)
Browse files Browse the repository at this point in the history
* examples

* flake8

* update the links to titanic
  • Loading branch information
haifeng-jin authored Jan 16, 2020
1 parent b39e814 commit 24fa453
Show file tree
Hide file tree
Showing 8 changed files with 67 additions and 622 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ AutoKeras: An AutoML system based on Keras.
It is developed by <a href="http://faculty.cs.tamu.edu/xiahu/index.html" target="_blank" rel="nofollow">DATA Lab</a> at Texas A&M University.
The goal of AutoKeras is to make machine learning accessible for everyone.

# AutoKeras 1.0 is coming soon!


## Example

Here is a short example of using the package.
Expand All @@ -34,11 +31,11 @@ For detailed tutorial, please check [here](https://autokeras.com/tutorial/overvi
To install the package, please use the `pip` installation as follows:

```shell
pip3 install autokeras # for 0.4 version
pip3 install autokeras==1.0.0b0 # for 1.0 version
pip3 install autokeras
```

**Note:** currently, AutoKeras is only compatible with: **Python 3**.
Please follow the [installation guide](https://autokeras.com/install) for more details.
**Note:** Currently, AutoKeras is only compatible with **Python 3**.

## Cite this work

Expand Down
7 changes: 5 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ extra_javascript:
nav:
- Home: index.md
- Installation: install.md
- Getting Started 1.0:
- Getting Started:
- Overview: tutorial/overview.md
- Image Classification: tutorial/image_classification.md
- Image Regression: tutorial/image_regression.md
Expand All @@ -38,7 +38,10 @@ nav:
- Multi-Modal and Multi-Task: tutorial/multi.md
- Customized Model: tutorial/customized.md
- Export Model: tutorial/export.md
- Getting Started 0.4: start.md
- Examples:
- MNIST Hand-Written Digits: examples/mnist.md
- IMDB Movie Reviews: examples/imdb.md
- Titanic Survival Prediction: examples/titanic.md
- Docker: docker.md
- Contributing Guide: contributing.md
- Documentation:
Expand Down
Loading

0 comments on commit 24fa453

Please sign in to comment.