provide some example usage and description #1
Conversation
README.rst
Outdated
|
|
||
| ⚠️ Papermill is a Work-in-progress and this README describes the intended state. 😁 | ||
| Stepping away from the hyperbole, the goals are to assist in: |
There was a problem hiding this comment.
the goals our goals for Papermill include simplifying and streamlining
README.rst
Outdated
| @@ -1,10 +1,44 @@ | |||
| |Logo| | |||
| ========= | |||
|
|
|||
| Papermill is map reduce for jupyter notebooks. | |||
|
|
||
| Usage | ||
| ----- | ||
|
|
There was a problem hiding this comment.
Caught me, I was under the assumption that this would all work in both. I'll make sure to set up tox here shortly. 😄
There was a problem hiding this comment.
Probably will work with both. Do you want both?
README.rst
Outdated
|
|
||
| nb = pm.read_notebook("output.ipynb") | ||
|
|
||
| Creating a parametrized notebook, recording metrics:: |
|
|
||
| rmse = metrics.mean_squared_error(...) | ||
| pm.record_value("rmse", rmse) | ||
| plot() # Tag this cell as "results" for extraction later |
There was a problem hiding this comment.
I would make the quotes consistent with line 52. Single or double.
There was a problem hiding this comment.
Somehow missed this one, whoops.
|
Whoa thanks @willingc! |
README.rst
Outdated
| pm.execute_notebook( | ||
| notebook="template.ipynb", | ||
| output="output.ipynb", | ||
| params=dict(alpha=0.1, l1_ratio=0.001) |
There was a problem hiding this comment.
Looking at the rendered view now, it would be nice to make l1_ratio more readable since the l and 1 are confusing side by side.
There was a problem hiding this comment.
That's so true. This is an artifact of the model being built underneath relying on linear_model.ElasticNet from scikit learn which has an l1_ratio parameter. Since this is for the readme I'll make it just ratio since it's for illustration purposes.
Kicking off a README that fleshes the ideas out a bit more.