Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit 917e193

Browse files
author
John Andersen
committed
README: Point to documentation website
Signed-off-by: John Andersen <[email protected]>
1 parent c1a9bae commit 917e193

File tree

3 files changed

+40
-65
lines changed

3 files changed

+40
-65
lines changed

README.md

Lines changed: 9 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -2,76 +2,21 @@
22

33
[![Build Status](https://travis-ci.org/intel/dffml.svg?branch=master)](https://travis-ci.org/intel/dffml) [![codecov](https://codecov.io/gh/intel/dffml/branch/master/graph/badge.svg)](https://codecov.io/gh/intel/dffml) [![CII](https://bestpractices.coreinfrastructure.org/projects/2594/badge)](https://bestpractices.coreinfrastructure.org/projects/2594) [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/dffml/community)
44

5-
DFFML provides APIs for dataset generation and storage, and model definition
6-
using any machine learning framework, from high level down to low level use is
7-
supported.
8-
9-
The goal of DFFML is to build a community driven library of plugins for dataset
10-
generation and model definition. So that we as developers and researchers can
11-
quickly and easily plug and play various pieces of data with various model
12-
implementations.
13-
14-
Here's a quick demo showing how DFFML can be used to train on the iris dataset.
15-
The more we build up the library of plugins (which anyone can maintain, they
16-
don't have to be contributed upstream unless you want to) the more variations on
17-
model implementations and feature data generators we all have to work with.
18-
19-
![Demo](https://github.com/intel/dffml/raw/master/docs/images/iris_demo.gif)
20-
21-
Right now we've released a wrapper around the Tensorflow DNN estimator, and a
22-
set of feature generators which gather data from git repositories.
23-
24-
## Installation
25-
26-
DFFML currently should work with Python 3.6. However, only Python 3.7 is
27-
officially supported. This is because there are a lot of nice helper methods
28-
Python 3.7 implemented that we intend to use instead of re-implementing.
29-
30-
```python
31-
python3.7 -m pip install -U dffml
32-
```
33-
34-
You can also install the Features for Git Version Control, and Models for
35-
Tensorflow Library all at once.
36-
37-
- [DFFML Features for Git Version Control](feature/git/README.md)
38-
- [DFFML Models for Tensorflow Library](model/tensorflow/README.md)
39-
40-
If you want a quick how to on the iris dataset head to the
41-
[DFFML Models for Tensorflow Library](model/tensorflow/README.md) repo.
42-
43-
```python
44-
python3.7 -m pip install -U dffml[git,tensorflow]
45-
```
46-
47-
If you don't have Python 3.7 we have a docker image for you, or you can install
48-
`pyenv` which will quickly and easily give you Python 3.7. See
49-
[docs/INSTALL.md](docs/INSTALL.md) for more details.
50-
51-
## Usage
52-
53-
To start using `dffml` for data set generation with a single CLI command see
54-
[DFFML Features for Git Version Control](feature/git/README.md).
55-
56-
To start using `dffml` for machine learning with a few CLI commands see
57-
[DFFML Models for Tensorflow Library](model/tensorflow/README.md).
58-
595
## Documentation
606

61-
Start with [Architecture](docs/ARCHITECTURE.md).
7+
Documentation is hosted at https://intel.github.io/dffml/
628

639
## Contributing
6410

65-
DFFML is meant to be a community driven application. There are various segments you can help with:
66-
67-
- Found a bug, error in the docs or have a new idea, create an issue [here](https://github.com/intel/dffml/issues/new/choose).
68-
- Help us fix an [issue](https://github.com/intel/dffml/issues), refer to [HACKING](docs/HACKING.md) in the docs.
69-
- Make sure you go through [CONTRIBUTING.md](CONTRIBUTING.md) before contributing.
11+
DFFML is meant to be a community driven application. There are various segments
12+
you can help with:
7013

71-
### Tutorials
72-
Got an idea for a new feature/model, tutorials will help you write code that takes full advantage of the DFFML API. Making your next machine learning project a breeze to write!
73-
- Features: The [new feature tutorial](docs/tutorial/FEATURE.md) will walk you through how to write a new DFFML feature to generate new data for a dataset.
74-
- Models: The [new model tutorial](docs/tutorial/MODEL.md) will walk you through how to wrap your favorite framework or a custom implementation in the DFFML library's model API.
14+
- Found a bug, error in the docs or have a new idea, create an issue
15+
[here](https://github.com/intel/dffml/issues/new/choose).
16+
- Help us fix an [issue](https://github.com/intel/dffml/issues), refer to
17+
[HACKING](HACKING.md) in the docs.
18+
- Make sure you go through [CONTRIBUTING.md](CONTRIBUTING.md) before
19+
contributing.
7520

7621
## License
7722

docs/index.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,30 @@
66
Welcome to DFFML's documentation!
77
=================================
88

9-
Data Flow Facilitator for Machine Learning (DFFML)
9+
Data Flow Facilitator for Machine Learning (DFFML) provides APIs for dataset
10+
generation and storage, and model definition using any machine learning
11+
framework, from high level down to low level use is supported.
12+
13+
The goal of DFFML is to build a community driven library of plugins for dataset
14+
generation and model definition. So that we as developers and researchers can
15+
quickly and easily plug and play various pieces of data with various model
16+
implementations.
17+
18+
Here's a quick demo showing how DFFML can be used to train on the iris dataset.
19+
The more we build up the library of plugins (which anyone can maintain, they
20+
don't have to be contributed upstream unless you want to) the more variations on
21+
model implementations and feature data generators we all have to work with.
22+
23+
Right now we've released a wrapper around the Tensorflow DNN estimator, and a
24+
set of feature generators which gather data from git repositories.
25+
26+
## Example Usage
27+
28+
To start using `dffml` for data set generation with a single CLI command see
29+
[DFFML Features for Git Version Control](feature/git/README.md).
30+
31+
To start using `dffml` for machine learning on existing CSV data (Iris demo)
32+
see [DFFML Models for Tensorflow Library](model/tensorflow/README.md).
1033

1134
.. toctree::
1235
:glob:

docs/usage/installation.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,10 @@ If you want to stay on the bleeding edge of bug fixes, etc. Install via git.
1717
.. code-block:: bash
1818
1919
python3.7 -m pip install git+https://github.com/intel/dffml
20+
21+
You can also install the Features for Git Version Control, and Models for
22+
Tensorflow Library all at once.
23+
24+
.. code-block:: bash
25+
26+
python3.7 -m pip install -U dffml[git,tensorflow]

0 commit comments

Comments
 (0)