Skip to content

Commit f30904a

Browse files
committed
Moved some of the README notes to the quickstart guide.
The quickstart was more complete anyways. We'll continue it there.
1 parent bd2d9bb commit f30904a

File tree

2 files changed

+32
-23
lines changed

2 files changed

+32
-23
lines changed

README.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,8 @@ These links should take you to the original data owners:
4040
- TIMIT - requires membership of the Linguistic Data Consortium (this is not free, but it is widely available in the research community).
4141
- Atari "Breakout" ROM - available online
4242

43-
## Running
43+
## Getting Started
4444

45-
#### Prerequisites:
46-
Fathom is tested with TensorFlow v0.8rc0, and due to API instability, there are issues with recent versions (Google has changed TF's layout several times). If you're willing to rename your functions and swap a couple import statements, recent versions of TF should work.
45+
We've begun to put together some actual documentation, and it's already better than what we had: [Fathom Quickstart Guide](http://fathom.readthedocs.io/en/latest/quickstart/).
4746

48-
Many of the models require external python libraries (e.g., [ALE](https://github.com/mgbellemare/Arcade-Learning-Environment) for DeepQ). Most of these are available as `pip` packages.
49-
50-
#### Running a single model:
51-
52-
Models can be run directly:
53-
```
54-
$ ./fathom/seq2seq/seq2seq.py
55-
```
56-
57-
Or as a library:
58-
```
59-
export PYTHONPATH=`pwd`/fathom
60-
$ python
61-
>>> from fathom import Seq2seq
62-
>>> model = Seq2seq()
63-
>>> model.setup()
64-
>>> model.run()
65-
```
47+
Please bear with us as the docs get fleshed out.

docs/quickstart.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,36 @@ The image will automatically be downloaded from the Docker hub, launched, and yo
5757

5858
# Downloading Data
5959

60-
*In progress*
60+
*<div style='color: red'>Documentation in progress</div>*
61+
62+
Fathom does not come with datasets suitable for training. This is a combination of size (realistic training sets are often massive) and licensing (an oft-repeated mantra is that good data is more valuable than a good model).
63+
Regardless, the inputs Fathom is designed for are standard and widely-available.
64+
65+
These links should take you to the original data owners:
66+
67+
- [ImageNet](http://www.image-net.org/download-images) - requires registration, but downloads are free for non-commercial purposes.
68+
- [WMT15](http://www.statmt.org/europarl/) - automatically downloaded by Fathom
69+
- [bAbI](https://research.facebook.com/research/babi/)
70+
- [MNIST](http://yann.lecun.com/exdb/mnist/) - automatically downloaded by Fathom.
71+
- [TIMIT](https://catalog.ldc.upenn.edu/ldc93s1) - requires membership of the Linguistic Data Consortium (this is not free, but it is widely available in the research community).
72+
- Atari "Breakout" ROM - [You'll have to find this on your own.](https://www.google.com/search?q=atari+breakout+rom)
6173

6274
# Running the Workloads
6375

64-
*In progress*
76+
*<div style='color: red'>Documentation in progress</div>*
77+
78+
Models can be run directly:
79+
```sh
80+
$ ./fathom/seq2seq/seq2seq.py
81+
```
82+
83+
Or as a library:
84+
```python
85+
export PYTHONPATH=`pwd`/fathom
86+
$ python
87+
>>> from fathom import Seq2seq
88+
>>> model = Seq2seq()
89+
>>> model.setup()
90+
>>> model.run()
91+
```
6592

0 commit comments

Comments
 (0)