|
2 | 2 |
|
3 | 3 | [](https://travis-ci.org/intel/dffml) [](https://codecov.io/gh/intel/dffml) [](https://bestpractices.coreinfrastructure.org/projects/2594) [](https://gitter.im/dffml/community) |
4 | 4 |
|
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 | | - |
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 | | - |
59 | 5 | ## Documentation |
60 | 6 |
|
61 | | -Start with [Architecture](docs/ARCHITECTURE.md). |
| 7 | +Documentation is hosted at https://intel.github.io/dffml/ |
62 | 8 |
|
63 | 9 | ## Contributing |
64 | 10 |
|
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: |
70 | 13 |
|
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. |
75 | 20 |
|
76 | 21 | ## License |
77 | 22 |
|
|
0 commit comments