Skip to content

Commit 97e2f8c

Browse files
committed
make the README portable, so that it can be rendered on pypi/anaconda servers
- include full path to images - group images together
1 parent 3ee74b0 commit 97e2f8c

File tree

5 files changed

+8
-4
lines changed

5 files changed

+8
-4
lines changed

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@ A fast and simple progress bar for Jupyter Notebook and console. Created by Sylv
44

55
Copyright 2017 onwards, fast.ai. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. A copy of the License is provided in the LICENSE file in this repository.
66

7-
<img src="cifar_train.gif" width="600">
7+
<img src="https://github.com/fastai/fastprogress/raw/master/images/cifar_train.gif" width="600">
88

99
## Install
1010

1111
To install simply use
1212
```
1313
pip install fastprogress
1414
```
15+
or:
16+
```
17+
conda install fastprogress
18+
```
1519
Note that this requires python 3.6 or later.
1620

1721
## Usage
@@ -34,7 +38,7 @@ for i in mb:
3438
#mb.update_graph(graphs, x_bounds, y_bounds)
3539
```
3640

37-
<img src="pb_basic.gif" width="600">
41+
<img src="https://github.com/fastai/fastprogress/raw/master/images/pb_basic.gif" width="600">
3842

3943
To add a graph that get plots as the training goes, just use the command mb.update_graphs. It will create the figure on its first use. Arguments are:
4044
- graphs: a list of graphs to be plotted (each of the form [x,y])
@@ -64,10 +68,10 @@ for i in mb:
6468
mb.write(f'Finished loop {i}.')
6569
```
6670

67-
<img src="pb_cos.gif" width="600">
71+
<img src="https://github.com/fastai/fastprogress/raw/master/images/pb_cos.gif" width="600">
6872

6973
Here is the rendering in console:
7074

71-
<img src="pb_console.gif" width="800">
75+
<img src="https://github.com/fastai/fastprogress/raw/master/images/pb_console.gif" width="800">
7276

7377
If the script using this is executed with a redirect to a file, only the results of the .write method will be printed in that file.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)