Merge pull request #14 from MKhalusova/workflows

GitHub workflows & toctree
huggingface · Feb 1, 2024 · e4df795 · e4df795
2 parents c1c87fb + ad3bf7f
commit e4df795
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 0 deletions.
diff --git a/.github/workflows/build_documentation.yml b/.github/workflows/build_documentation.yml
@@ -0,0 +1,20 @@
+name: Build documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main
+    with:
+      commit_sha: ${{ github.sha }}
+      package: cookbook
+      package_name: cookbook
+      path_to_docs: cookbook/notebooks/
+      additional_args: --not_python_module
+      languages: en
+      convert_notebooks: true
+    secrets:
+      hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
diff --git a/.github/workflows/build_pr_documentation.yml b/.github/workflows/build_pr_documentation.yml
@@ -0,0 +1,21 @@
+name: Build PR Documentation
+
+on:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@main
+    with:
+      commit_sha: ${{ github.event.pull_request.head.sha }}
+      pr_number: ${{ github.event.number }}
+      package: cookbook
+      package_name: cookbook
+      path_to_docs: cookbook/notebooks/
+      additional_args: --not_python_module
+      languages: en
+      convert_notebooks: true
diff --git a/.github/workflows/upload_pr_documentation.yml b/.github/workflows/upload_pr_documentation.yml
@@ -0,0 +1,17 @@
+name: Upload PR Documentation
+
+on:
+  workflow_run:
+    workflows: ["Build PR Documentation"]
+    types:
+      - completed
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/upload_pr_documentation.yml@main
+    with:
+      package_name: cookbook
+      hub_base_path: https://moon-ci-docs.huggingface.co/learn
+    secrets:
+      hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
+      comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }}
diff --git a/...oks/FAISS_with_HF_datasets_and_CLIP.ipynb → .../en/FAISS_with_HF_datasets_and_CLIP.ipynb b/...oks/FAISS_with_HF_datasets_and_CLIP.ipynb → .../en/FAISS_with_HF_datasets_and_CLIP.ipynb
diff --git a/.../Fine_tuning_Code_LLM_on_single_GPU.ipynb → .../Fine_tuning_Code_LLM_on_single_GPU.ipynb b/.../Fine_tuning_Code_LLM_on_single_GPU.ipynb → .../Fine_tuning_Code_LLM_on_single_GPU.ipynb
diff --git a/notebooks/RAG_evaluation.ipynb → notebooks/en/RAG_evaluation.ipynb b/notebooks/RAG_evaluation.ipynb → notebooks/en/RAG_evaluation.ipynb
diff --git a/notebooks/RAG_zephyr_langchain.ipynb → notebooks/en/RAG_zephyr_langchain.ipynb b/notebooks/RAG_zephyr_langchain.ipynb → notebooks/en/RAG_zephyr_langchain.ipynb
diff --git a/notebooks/en/_toctree.yml b/notebooks/en/_toctree.yml
@@ -0,0 +1,14 @@
+- title: Open-Source AI Cookbook
+  sections:
+  - local: index
+    title: Open-Source AI Cookbook
+  - local: FAISS_with_HF_datasets_and_CLIP
+    title: Embedding multimodal data for similarity search
+  - local: Fine_tuning_Code_LLM_on_single_GPU
+    title: Fine-tuning a Code LLM on Custom Code on a single GPU
+  - local: RAG_zephyr_langchain
+    title: Simple RAG using Hugging Face Zephyr and LangChain
+  - local: advanced_RAG
+    title: Advanced RAG on HuggingFace documentation using LangChain
+  - local: RAG_evaluation
+    title: RAG Evaluation
diff --git a/notebooks/advanced_RAG.ipynb → notebooks/en/advanced_RAG.ipynb b/notebooks/advanced_RAG.ipynb → notebooks/en/advanced_RAG.ipynb
diff --git a/notebooks/en/index.md b/notebooks/en/index.md
@@ -0,0 +1,3 @@
+# Open-Source AI Cookbook
+
+we cooking