Skip to content

Commit 62ce155

Browse files
mv demo nbs into src folder and add fn for cloning to current dir
Signed-off-by: Kevin <[email protected]>
1 parent ecf04c3 commit 62ce155

27 files changed

+30
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ An intuitive, easy-to-use python interface for batch resource requesting, access
77

88
For guided demos and basics walkthroughs, check out the following links:
99

10-
- Guided demo notebooks available [here](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos), and copies of the notebooks with [expected output](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/notebook-ex-outputs) also available
11-
- Note that these notebooks will work with the latest `codeflare-sdk` PyPI release. For testing and experimentation with `main` branch, please use the [preview notebooks](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/preview_nbs)
10+
- Guided demo notebooks available [here](https://github.com/project-codeflare/codeflare-sdk/tree/main/src/demo-notebooks/guided-demos), and copies of the notebooks with [expected output](https://github.com/project-codeflare/codeflare-sdk/tree/main/src/demo-notebooks/guided-demos/notebook-ex-outputs) also available
11+
- these demos can be copied into your current working directory when using the `codeflare-sdk` by using the `codeflare_sdk.copy_demo_nbs()` function
1212
- Additionally, we have a [video walkthrough](https://www.youtube.com/watch?v=U76iIfd9EmE) of these basic demos from June, 2023
1313

1414
Full documentation can be found [here](https://project-codeflare.github.io/codeflare-sdk/detailed-documentation)

src/codeflare_sdk/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
from .job import RayJobClient
2020

2121
from .utils import generate_cert
22+
from .utils.demos import copy_demo_nbs
2223

2324
from importlib.metadata import version, PackageNotFoundError
2425

0 commit comments

Comments
 (0)