Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note on using AWS_PROFILE to docs #235

Merged
merged 3 commits into from Jun 29, 2019
Merged

Add note on using AWS_PROFILE to docs #235

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a3b1e3
Add note on using AWS_PROFILE to docs
Oct 17, 2018
4a43e0a
Caught changes back to master
MSeal Jun 29, 2019
ce3a11b
Changed tox setting back from local test
MSeal Jun 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/usage.rst
View file
Open in desktop
Expand Up @@ -48,6 +48,17 @@ Amazon S3 account:

$ papermill local/input.ipynb s3://bkt/output.ipynb -p alpha 0.6 -p l1_ratio 0.1

**NOTE:**

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:

.. code-block:: bash

$ AWS_PROFILE=dev_account papermill local/input.ipynb s3://bkt/output.ipynb -p alpha 0.6 -p l1_ratio 0.1

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:

.. code-block:: bash
Expand Down Expand Up @@ -184,4 +195,4 @@ Papermill can read in a directory of notebooks and provides the
# Dataframe for all notebooks in collection
nbs.dataframe.head(10)

.. image:: img/nbs_dataframe.png
.. image:: img/nbs_dataframe.png