Skip to content

Commit

Permalink
Merge pull request #552 from EducationalTestingService/feature/448-in…
Browse files Browse the repository at this point in the history
…teractive-binder

Add interactive hosted notebook with examples.
  • Loading branch information
desilinguist committed Oct 17, 2019
2 parents 487e69e + 604c2eb commit b450a9f
Show file tree
Hide file tree
Showing 4 changed files with 1,502 additions and 2 deletions.
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ SciKit-Learn Laboratory
:target: http://dx.doi.org/10.5281/zenodo.12825
:alt: DOI for citing SKLL 1.0.0

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/EducationalTestingService/skll/master?filepath=examples%2FTutorial.ipynb


This Python package provides command-line utilities to make it easier to run
machine learning experiments with scikit-learn. One of the primary goals of
our project is to make it so that you can run scikit-learn experiments without
Expand Down Expand Up @@ -82,6 +86,8 @@ For more information about getting started with ``run_experiment``, please check
out `our tutorial <https://skll.readthedocs.org/en/latest/tutorial.html>`__, or
`our config file specs <https://skll.readthedocs.org/en/latest/run_experiment.html>`__.

You can also follow this `interactive Jupyter tutorial <https://mybinder.org/v2/gh/AVajpayeeJr/skll/feature/448-interactive-binder?filepath=examples>`__.

We also provide utilities for:

- `converting between machine learning toolkit formats <https://skll.readthedocs.org/en/latest/utilities.html#skll-convert>`__
Expand Down
11 changes: 9 additions & 2 deletions doc/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Tutorial
========

Before doing anything below, you'll want to :ref:`install SKLL <install>`.
Before doing anything below, you'll want to :ref:`install SKLL <install>`.

Workflow
--------
Expand All @@ -15,7 +15,7 @@ In general, there are four steps to using SKLL:
2. Create a small :ref:`configuration file <create_config>` describing the
machine learning experiment you would like to run.
3. Run that configuration file with :ref:`run_experiment <run_experiment>`.
4. Examine results
4. Examine the results of the experiment.

Titanic Example
---------------
Expand Down Expand Up @@ -204,6 +204,13 @@ An example of a human-readable results file for our Titanic config file is::
roc_auc = 0.8219429347826087


IRIS Example on Binder
----------------------
If you prefer using an interactive Jupyter notebook to learn about SKLL, you can do so by clicking the launch button below.

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/EducationalTestingService/skll/master?filepath=examples%2FTutorial.ipynb

Running your own experiments
----------------------------

Expand Down

0 comments on commit b450a9f

Please sign in to comment.