Refactor README.md file to divide the folder into 2 sections: (#3686) · developer982/python-docs-samples@da4191b · GitHub
Skip to content

Commit da4191b

Browse files
authored
Refactor README.md file to divide the folder into 2 sections: (GoogleCloudPlatform#3686)
1. Jupyter Notebooks tutorials using AI Platform notebooks. 2. AI Platform API code samples https://cloud.google.com/ai-platform/notebooks/docs/reference/rest
1 parent 2895655 commit da4191b

4 files changed

Lines changed: 79 additions & 6 deletions

File tree

notebooks/README.md

Lines changed: 38 additions & 6 deletions

notebooks/samples/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# AI Platform Notebooks API code samples
2+
3+
Sample command-line programs for interacting with the Notebooks API.
4+
5+
## Prerequisites to run locally:
6+
7+
* [Python 3](https://www.python.org/downloads/)
8+
* [pip](https://pypi.python.org/pypi/pip)
9+
10+
Go to the [Google Cloud Console](https://console.cloud.google.com).
11+
12+
Under API Manager, search for the Google Cloud Notebooks API and enable
13+
it. You can also enable API via Command Line:
14+
15+
```bash
16+
gcloud services enable notebooks.googleapis.com
17+
```
18+
19+
## Set Up Your Local Dev Environment
20+
21+
To install, run the following commands. If you want to use
22+
[virtualenv](https://virtualenv.readthedocs.org/en/latest/)
23+
(recommended), run the commands within a virtualenv.
24+
25+
```bash
26+
pip install -r requirements.txt
27+
```
28+
29+
**Note:** While this sample demonstrates interacting with Notebooks via
30+
the API, the functionality demonstrated here could also be accomplished
31+
using the Cloud Console or the
32+
[gcloud CLI](https://cloud.google.com/sdk/gcloud/reference/beta/notebooks)
33+
34+
## Authentication
35+
36+
Please see the
37+
[Google cloud authentication guide](https://cloud.google.com/docs/authentication/).
38+
The recommended approach to running these samples is a Service Account
39+
with a JSON key.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pytest==5.3.2

notebooks/samples/requirements.txt

Lines changed: 1 addition & 0 deletions

0 commit comments

Comments
 (0)