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.

Sign up for GitHub

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

PR: Add notebook documentation #143

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

PR: Add notebook documentation #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions notebooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Running the record api tooling on notebooks

First of all, clone the record api repo

```
git clone https://github.com/data-apis/python-record-api.git
```

And create a new conda env for installing all the notebook's dependencies and the record api tooling.

```
conda create -n record-api python=3.8
conda activate record-api
cd python-record-api
pip install record_api
```

We have an example of a notebook under `/notebooks/data`, so we need to transform it
to a python file so the record api tooling work.

```
cd notebooks
python notebook_to_python.py data
```

A new folder named `scripts` under the `notebooks` directory will be created with
all the files converted into python files.

Then, run the file `run_record_api.sh` to generate the inferred API calls in each notebook.
The output will be under `infer_apis` directory as a json per notebook file.
Loading