From 5262e26aa4c828341c4df91e34bec9fc7b51fb44 Mon Sep 17 00:00:00 2001 From: Bobbins228 Date: Fri, 26 Jul 2024 16:13:46 +0100 Subject: [PATCH] Fixed automated documentation --- .github/workflows/release.yaml | 7 ++++--- .../additional-demos/hf_interactive.ipynb | 0 .../additional-demos/local_interactive.ipynb | 0 .../additional-demos/ray_job_client.ipynb | 0 .../guided-demos/0_basic_ray.ipynb | 0 .../guided-demos/1_cluster_job_client.ipynb | 0 .../guided-demos/2_basic_interactive.ipynb | 0 .../guided-demos/download_mnist_datasets.py | 0 .../guided-demos/mnist.py | 0 .../guided-demos/mnist_disconnected.py | 0 .../guided-demos/mnist_fashion.py | 0 .../guided-demos/notebook-ex-outputs/0_basic_ray.ipynb | 0 .../notebook-ex-outputs/1_cluster_job_client.ipynb | 0 .../notebook-ex-outputs/2_basic_interactive.ipynb | 0 .../guided-demos/notebook-ex-outputs/interactivetest.yaml | 0 .../guided-demos/notebook-ex-outputs/jobtest.yaml | 0 .../guided-demos/notebook-ex-outputs/mnist.py | 0 .../guided-demos/notebook-ex-outputs/raytest.yaml | 0 .../guided-demos/notebook-ex-outputs/requirements.txt | 0 .../guided-demos/preview_nbs/0_basic_ray.ipynb | 0 .../guided-demos/preview_nbs/1_cluster_job_client.ipynb | 0 .../guided-demos/preview_nbs/2_basic_interactive.ipynb | 0 .../guided-demos/preview_nbs/mnist.py | 0 .../guided-demos/preview_nbs/requirements.txt | 0 .../guided-demos/requirements.txt | 0 25 files changed, 4 insertions(+), 3 deletions(-) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/additional-demos/hf_interactive.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/additional-demos/local_interactive.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/additional-demos/ray_job_client.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/0_basic_ray.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/1_cluster_job_client.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/2_basic_interactive.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/download_mnist_datasets.py (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/mnist.py (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/mnist_disconnected.py (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/mnist_fashion.py (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/notebook-ex-outputs/0_basic_ray.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/notebook-ex-outputs/1_cluster_job_client.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/notebook-ex-outputs/2_basic_interactive.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/notebook-ex-outputs/interactivetest.yaml (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/notebook-ex-outputs/jobtest.yaml (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/notebook-ex-outputs/mnist.py (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/notebook-ex-outputs/raytest.yaml (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/notebook-ex-outputs/requirements.txt (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/preview_nbs/0_basic_ray.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/preview_nbs/1_cluster_job_client.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/preview_nbs/2_basic_interactive.ipynb (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/preview_nbs/mnist.py (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/preview_nbs/requirements.txt (100%) rename {src/codeflare_sdk/demo-notebooks => demo-notebooks}/guided-demos/requirements.txt (100%) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 0d589d951..641a148d0 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -50,11 +50,12 @@ jobs: run: poetry version "${{ github.event.inputs.release-version }}" - name: Run poetry install run: poetry install --with docs - - name: Run poetry build - run: poetry build - name: Create new documentation run: poetry run pdoc --html -o docs/detailed-documentation src/codeflare_sdk && pushd docs/detailed-documentation && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd && find docs/detailed-documentation -type f -name "*.html" -exec bash -c "echo '' >> {}" \; - + - name: Copy demo notebooks into SDK package + run: cp demo-notebooks src/codeflare_sdk/demo-notebooks + - name: Run poetry build + run: poetry build - name: Commit changes in docs uses: stefanzweifel/git-auto-commit-action@v4 with: diff --git a/src/codeflare_sdk/demo-notebooks/additional-demos/hf_interactive.ipynb b/demo-notebooks/additional-demos/hf_interactive.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/additional-demos/hf_interactive.ipynb rename to demo-notebooks/additional-demos/hf_interactive.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/additional-demos/local_interactive.ipynb b/demo-notebooks/additional-demos/local_interactive.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/additional-demos/local_interactive.ipynb rename to demo-notebooks/additional-demos/local_interactive.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/additional-demos/ray_job_client.ipynb b/demo-notebooks/additional-demos/ray_job_client.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/additional-demos/ray_job_client.ipynb rename to demo-notebooks/additional-demos/ray_job_client.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/0_basic_ray.ipynb b/demo-notebooks/guided-demos/0_basic_ray.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/0_basic_ray.ipynb rename to demo-notebooks/guided-demos/0_basic_ray.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/1_cluster_job_client.ipynb b/demo-notebooks/guided-demos/1_cluster_job_client.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/1_cluster_job_client.ipynb rename to demo-notebooks/guided-demos/1_cluster_job_client.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/2_basic_interactive.ipynb b/demo-notebooks/guided-demos/2_basic_interactive.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/2_basic_interactive.ipynb rename to demo-notebooks/guided-demos/2_basic_interactive.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/download_mnist_datasets.py b/demo-notebooks/guided-demos/download_mnist_datasets.py similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/download_mnist_datasets.py rename to demo-notebooks/guided-demos/download_mnist_datasets.py diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/mnist.py b/demo-notebooks/guided-demos/mnist.py similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/mnist.py rename to demo-notebooks/guided-demos/mnist.py diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/mnist_disconnected.py b/demo-notebooks/guided-demos/mnist_disconnected.py similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/mnist_disconnected.py rename to demo-notebooks/guided-demos/mnist_disconnected.py diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/mnist_fashion.py b/demo-notebooks/guided-demos/mnist_fashion.py similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/mnist_fashion.py rename to demo-notebooks/guided-demos/mnist_fashion.py diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/0_basic_ray.ipynb b/demo-notebooks/guided-demos/notebook-ex-outputs/0_basic_ray.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/0_basic_ray.ipynb rename to demo-notebooks/guided-demos/notebook-ex-outputs/0_basic_ray.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/1_cluster_job_client.ipynb b/demo-notebooks/guided-demos/notebook-ex-outputs/1_cluster_job_client.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/1_cluster_job_client.ipynb rename to demo-notebooks/guided-demos/notebook-ex-outputs/1_cluster_job_client.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/2_basic_interactive.ipynb b/demo-notebooks/guided-demos/notebook-ex-outputs/2_basic_interactive.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/2_basic_interactive.ipynb rename to demo-notebooks/guided-demos/notebook-ex-outputs/2_basic_interactive.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/interactivetest.yaml b/demo-notebooks/guided-demos/notebook-ex-outputs/interactivetest.yaml similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/interactivetest.yaml rename to demo-notebooks/guided-demos/notebook-ex-outputs/interactivetest.yaml diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/jobtest.yaml b/demo-notebooks/guided-demos/notebook-ex-outputs/jobtest.yaml similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/jobtest.yaml rename to demo-notebooks/guided-demos/notebook-ex-outputs/jobtest.yaml diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/mnist.py b/demo-notebooks/guided-demos/notebook-ex-outputs/mnist.py similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/mnist.py rename to demo-notebooks/guided-demos/notebook-ex-outputs/mnist.py diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/raytest.yaml b/demo-notebooks/guided-demos/notebook-ex-outputs/raytest.yaml similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/raytest.yaml rename to demo-notebooks/guided-demos/notebook-ex-outputs/raytest.yaml diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/requirements.txt b/demo-notebooks/guided-demos/notebook-ex-outputs/requirements.txt similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/notebook-ex-outputs/requirements.txt rename to demo-notebooks/guided-demos/notebook-ex-outputs/requirements.txt diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/0_basic_ray.ipynb b/demo-notebooks/guided-demos/preview_nbs/0_basic_ray.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/0_basic_ray.ipynb rename to demo-notebooks/guided-demos/preview_nbs/0_basic_ray.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/1_cluster_job_client.ipynb b/demo-notebooks/guided-demos/preview_nbs/1_cluster_job_client.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/1_cluster_job_client.ipynb rename to demo-notebooks/guided-demos/preview_nbs/1_cluster_job_client.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/2_basic_interactive.ipynb b/demo-notebooks/guided-demos/preview_nbs/2_basic_interactive.ipynb similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/2_basic_interactive.ipynb rename to demo-notebooks/guided-demos/preview_nbs/2_basic_interactive.ipynb diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/mnist.py b/demo-notebooks/guided-demos/preview_nbs/mnist.py similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/mnist.py rename to demo-notebooks/guided-demos/preview_nbs/mnist.py diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/requirements.txt b/demo-notebooks/guided-demos/preview_nbs/requirements.txt similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/preview_nbs/requirements.txt rename to demo-notebooks/guided-demos/preview_nbs/requirements.txt diff --git a/src/codeflare_sdk/demo-notebooks/guided-demos/requirements.txt b/demo-notebooks/guided-demos/requirements.txt similarity index 100% rename from src/codeflare_sdk/demo-notebooks/guided-demos/requirements.txt rename to demo-notebooks/guided-demos/requirements.txt