You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It's possible you will have conflicts between your repository and main. Here, `main` is meant to be synchronized with the ```upstream``` repository. GitHub has some good [documentation](https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/) on merging pull requests from the command line.
152
+
It's possible you will have conflicts between your repository and main. Here, `main` is meant to be synchronized with the `upstream` repository. GitHub has some good [documentation](https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/) on merging pull requests from the command line.
This opens up new opportunities for how notebooks can be used. For
25
25
example:
26
26
27
-
-Perhaps you have a financial report that you wish to run with
28
-
different values on the first or last day of a month or at the
29
-
beginning or end of the year, **using parameters** makes this task
30
-
easier.
31
-
-Do you want to run a notebook and depending on its results, choose a
32
-
particular notebook to run next? You can now programmatically
33
-
**execute a workflow** without having to copy and paste from
34
-
notebook to notebook manually.
27
+
- Perhaps you have a financial report that you wish to run with
28
+
different values on the first or last day of a month or at the
29
+
beginning or end of the year, **using parameters** makes this task
30
+
easier.
31
+
- Do you want to run a notebook and depending on its results, choose a
32
+
particular notebook to run next? You can now programmatically
33
+
**execute a workflow** without having to copy and paste from
34
+
notebook to notebook manually.
35
35
36
36
Papermill takes an *opinionated* approach to notebook parameterization and
37
37
execution based on our experiences using notebooks at scale in data
@@ -41,14 +41,14 @@ pipelines.
41
41
42
42
From the command line:
43
43
44
-
```{.sourceCode .bash}
44
+
```{.sourceCode .bash}
45
45
pip install papermill
46
46
```
47
47
48
48
For all optional io dependencies, you can specify individual bundles
49
-
like `s3`, or `azure` -- or use `all`. To use Black to format parameters you can add as an extra requires ['black'].
49
+
like `s3`, or `azure` -- or use `all`. To use Black to format parameters you can add as an extra requires \['black'\].
50
50
51
-
```{.sourceCode .bash}
51
+
```{.sourceCode .bash}
52
52
pip install papermill[all]
53
53
```
54
54
@@ -62,13 +62,13 @@ drop support in the future.
62
62
63
63
### Parameterizing a Notebook
64
64
65
-
To parameterize your notebook designate a cell with the tag ``parameters``.
65
+
To parameterize your notebook designate a cell with the tag `parameters`.
66
66
67
67
68
68
69
-
Papermill looks for the ``parameters`` cell and treats this cell as defaults for the parameters passed in at execution time. Papermill will add a new cell tagged with ``injected-parameters`` with input parameters in order to overwrite the values in ``parameters``. If no cell is tagged with ``parameters`` the injected cell will be inserted at the top of the notebook.
69
+
Papermill looks for the `parameters` cell and treats this cell as defaults for the parameters passed in at execution time. Papermill will add a new cell tagged with `injected-parameters` with input parameters in order to overwrite the values in `parameters`. If no cell is tagged with `parameters` the injected cell will be inserted at the top of the notebook.
70
70
71
-
Additionally, if you rerun notebooks through papermill and it will reuse the ``injected-parameters`` cell from the prior run. In this case Papermill will replace the old ``injected-parameters`` cell with the new run's inputs.
71
+
Additionally, if you rerun notebooks through papermill and it will reuse the `injected-parameters` cell from the prior run. In this case Papermill will replace the old `injected-parameters` cell with the new run's inputs.
72
72
73
73
74
74
@@ -79,7 +79,7 @@ the Python API and (2) through the command line interface.
79
79
80
80
#### Execute via the Python API
81
81
82
-
```{.sourceCode .python}
82
+
```{.sourceCode .python}
83
83
import papermill as pm
84
84
85
85
pm.execute_notebook(
@@ -94,48 +94,48 @@ pm.execute_notebook(
94
94
Here's an example of a local notebook being executed and output to an
If you use multiple AWS accounts, and you have [properly configured your AWS credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html), then you can specify which account to use by setting the `AWS_PROFILE` environment variable at the command-line. For example:
In the above example, two parameters are set: ``alpha`` and ``l1_ratio`` using ``-p`` (``--parameters`` also works). Parameter values that look like booleans or numbers will be interpreted as such. Here are the different ways users may set parameters:
108
+
In the above example, two parameters are set: `alpha` and `l1_ratio` using `-p` (`--parameters` also works). Parameter values that look like booleans or numbers will be interpreted as such. Here are the different ways users may set parameters:
109
109
110
-
```{.sourceCode .bash}
110
+
```{.sourceCode .bash}
111
111
$ papermill local/input.ipynb s3://bkt/output.ipynb -r version 1.0
112
112
```
113
113
114
-
Using ``-r`` or ``--parameters_raw``, users can set parameters one by one. However, unlike ``-p``, the parameter will remain a string, even if it may be interpreted as a number or boolean.
114
+
Using `-r` or `--parameters_raw`, users can set parameters one by one. However, unlike `-p`, the parameter will remain a string, even if it may be interpreted as a number or boolean.
* Google Cloud: [Google Cloud Storage](https://cloud.google.com/storage/)`gs://`
162
+
- Google Cloud: [Google Cloud Storage](https://cloud.google.com/storage/)`gs://`
163
163
164
-
Development Guide
165
-
-----------------
164
+
## Development Guide
166
165
167
166
Read [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to setup a local development environment and make code changes back to Papermill.
168
167
169
168
For development guidelines look in the [DEVELOPMENT_GUIDE.md](./DEVELOPMENT_GUIDE.md) file. This should inform you on how to make particular additions to the code base.
170
169
171
-
Documentation
172
-
-------------
170
+
## Documentation
173
171
174
172
We host the [Papermill documentation](http://papermill.readthedocs.io)
0 commit comments