Skip to content

Commit 735a627

Browse files
Plotting docs (#13)
* update plotting gifs * add gridplot functionality * use new plots in gallery and readme * change keyword for aggregate in scatter plot * update docstrings * add tests and example for gridplot
1 parent 684d7b1 commit 735a627

File tree

14 files changed

+428
-1286
lines changed

14 files changed

+428
-1286
lines changed

README.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Welcome to Henchman!
22
=====================
3-
Henchman is a collection of free and `open source
3+
Henchman is a collection of `open source
44
<LICENSE>`_ python
55
utility functions for working in a jupyter notebook. With
66
Henchman, you can rapidly prototype end-to-end data science
77
workflows. You can explore data with
88
``henchman.diagnostics``, make interesting plots with
99
``henchman.plotting``, and do feature selection and machine
1010
learning with ``henchman.selection`` and
11-
``henchman.learning``.
11+
``henchman.learning``. For more information, visit the henchman `documentation <henchman.featurelabs.com>`_.
1212

1313
Why?
1414
~~~~~~~
@@ -20,18 +20,20 @@ Henchman:
2020
analysis plots. With sliders and checkboxes, finding the
2121
right plot parameters is as easy as a single function call.
2222

23-
.. image:: docs/_source/img/dynamic_piechart.gif
23+
.. image:: docs/_source/img/piechart.gif
2424
:width: 47%
2525
:height: 300px
26-
.. image:: docs/_source/img/dynamic_histogram.gif
26+
.. image:: docs/_source/img/histogram.gif
2727
:width: 47%
2828
:height: 300px
2929

30-
- **Memorable API, Extensive documentation**: We have a heavy
31-
emphasis on ease of use. That means all the functions are
32-
sorted into one of 4 semantically named modules and names
33-
should be easy to remember inside that module. On top of
34-
that, every function has a docstring, an example and a documentation page.
30+
- **Memorable API, Extensive documentation**: We have a
31+
heavy emphasis on ease of use. That means all the
32+
functions are sorted into one of 4 semantically named
33+
modules and names should be easy to remember inside that
34+
module. On top of that, every function has a docstring, an
35+
example and a `documentation <henchman.featurelabs.com>`_
36+
page.
3537

3638
.. image:: docs/_source/img/create_model_docs.png
3739
:width: 75%
@@ -62,7 +64,7 @@ To install Henchman, run this command in your terminal:
6264

6365
.. code-block:: console
6466
65-
$ python -m pip install ft-henchman
67+
$ python -m pip install fl-henchman
6668
6769
This is the preferred method to install Henchman, as it will always install the most recent stable release.
6870

docs/_source/documentation.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -187,20 +187,19 @@ We can check :func:`feature importances
187187

188188
.. _plotting:
189189

190-
Plotting
191-
~~~~~~~~
192-
The plotting module gives a collection of useful
193-
dataset agnostic plots. There are *static* plots which which
194-
have tunable controls to give a good exportable, image and
195-
there are *dynamic* plots which are fun and useful for
196-
dataset exploration. We recommend importing the whole module
197-
at once using ``import henchman.plotting as hplot`` for easy
198-
access to all of the functions. The single exception might
199-
be :func:`henchman.plotting.show`, which is useful enough that you might consider
200-
importing it as itself.
190+
Plotting
191+
~~~~~~~~~
192+
193+
The plotting module gives a collection of useful dataset
194+
agnostic plots. Plots have the ability to be *dynamic* or
195+
*static*. We recommend importing the whole module at once
196+
using ``import henchman.plotting as hplot`` for easy access
197+
to all of the functions. The single exception might be
198+
:func:`henchman.plotting.show`, which is useful enough that
199+
you might consider importing it as itself.
201200

202201
The :func:`show <henchman.plotting.show>` function has many parameters which can be hard
203-
to remember. Because of that, there's a :func:`templating function <henchman.plotting.show_template>` from which you can copy and paste the ones you want.
202+
to remember. Because of that, there's a :func:`templating function <henchman.plotting.show_template>` from which you can copy and paste the arguments you want.
204203

205204
.. ipython:: python
206205
-1000 KB
Binary file not shown.
-318 KB
Binary file not shown.

docs/_source/img/histogram.gif

553 KB
Loading

docs/_source/img/piechart.gif

151 KB
Loading

docs/_source/img/scatter.gif

153 KB
Loading

docs/_source/img/timeseries.gif

1.19 MB
Loading

docs/_source/plotting_gallery.ipynb

Lines changed: 330 additions & 1232 deletions
Large diffs are not rendered by default.

docs/_source/readme.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Welcome to Henchman!
22
=====================
3-
Henchman is a collection of free and open source python
3+
Henchman is a collection of open source python
44
utility functions for working in a jupyter notebook. With
55
Henchman, you can rapidly prototype end-to-end data science
66
workflows. You can explore data with
@@ -19,12 +19,16 @@ Henchman:
1919
analysis plots. With sliders and checkboxes, finding the
2020
right plot parameters is as easy as a single function call.
2121

22-
.. image:: img/dynamic_piechart.gif
22+
.. image:: img/piechart.gif
2323
:width: 47%
24-
:height: 300px
25-
.. image:: img/dynamic_histogram.gif
24+
:height: 400px
25+
.. image:: img/histogram.gif
2626
:width: 47%
27-
:height: 300px
27+
:height: 400px
28+
29+
.. image:: img/timeseries.gif
30+
:height: 400px
31+
:align: center
2832

2933
- **Memorable API, Extensive documentation**: We have a heavy
3034
emphasis on ease of use. That means all the functions are
@@ -61,7 +65,7 @@ To install Henchman, run this command in your terminal:
6165

6266
.. code-block:: console
6367
64-
$ python -m pip install ft-henchman
68+
$ python -m pip install fl-henchman
6569
6670
This is the preferred method to install Henchman, as it will always install the most recent stable release.
6771

0 commit comments

Comments
 (0)