From edd5b6a3fc1f202632a03515da2d6bfd8c043f05 Mon Sep 17 00:00:00 2001 From: Mishig Davaadorj Date: Fri, 2 Feb 2024 12:27:43 +0100 Subject: [PATCH 1/4] Check notebooks are lowercase --- .../workflows/check_notebooks_lowercase.yml | 25 +++++++++++++++++++ ...{advanced_RAG.ipynb => advanced_rag.ipynb} | 0 ... => faiss_with_hf_datasets_and_clip.ipynb} | 0 ... fine_tuning_code_llm_on_single_gpu.ipynb} | 0 ..._evaluation.ipynb => rag_evaluation.ipynb} | 0 ...chain.ipynb => rag_zephyr_langchain.ipynb} | 0 6 files changed, 25 insertions(+) create mode 100644 .github/workflows/check_notebooks_lowercase.yml rename notebooks/en/{advanced_RAG.ipynb => advanced_rag.ipynb} (100%) rename notebooks/en/{FAISS_with_HF_datasets_and_CLIP.ipynb => faiss_with_hf_datasets_and_clip.ipynb} (100%) rename notebooks/en/{Fine_tuning_Code_LLM_on_single_GPU.ipynb => fine_tuning_code_llm_on_single_gpu.ipynb} (100%) rename notebooks/en/{RAG_evaluation.ipynb => rag_evaluation.ipynb} (100%) rename notebooks/en/{RAG_zephyr_langchain.ipynb => rag_zephyr_langchain.ipynb} (100%) diff --git a/.github/workflows/check_notebooks_lowercase.yml b/.github/workflows/check_notebooks_lowercase.yml new file mode 100644 index 00000000..040155e3 --- /dev/null +++ b/.github/workflows/check_notebooks_lowercase.yml @@ -0,0 +1,25 @@ +name: Check nteobook names are lowercase + +on: [push] + +jobs: + check-lowercase: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Check filenames in 'notebooks/' + run: | + # Change to the directory where you want to check filenames + cd notebooks + # Find files with uppercase characters in their names + files=$(find . -type f | grep '[A-Z]' || true) + if [ -n "$files" ]; then + echo "The following files are not lowercase:" + echo "$files" + exit 1 + else + echo "All filenames are lowercase." + exit 0 + fi \ No newline at end of file diff --git a/notebooks/en/advanced_RAG.ipynb b/notebooks/en/advanced_rag.ipynb similarity index 100% rename from notebooks/en/advanced_RAG.ipynb rename to notebooks/en/advanced_rag.ipynb diff --git a/notebooks/en/FAISS_with_HF_datasets_and_CLIP.ipynb b/notebooks/en/faiss_with_hf_datasets_and_clip.ipynb similarity index 100% rename from notebooks/en/FAISS_with_HF_datasets_and_CLIP.ipynb rename to notebooks/en/faiss_with_hf_datasets_and_clip.ipynb diff --git a/notebooks/en/Fine_tuning_Code_LLM_on_single_GPU.ipynb b/notebooks/en/fine_tuning_code_llm_on_single_gpu.ipynb similarity index 100% rename from notebooks/en/Fine_tuning_Code_LLM_on_single_GPU.ipynb rename to notebooks/en/fine_tuning_code_llm_on_single_gpu.ipynb diff --git a/notebooks/en/RAG_evaluation.ipynb b/notebooks/en/rag_evaluation.ipynb similarity index 100% rename from notebooks/en/RAG_evaluation.ipynb rename to notebooks/en/rag_evaluation.ipynb diff --git a/notebooks/en/RAG_zephyr_langchain.ipynb b/notebooks/en/rag_zephyr_langchain.ipynb similarity index 100% rename from notebooks/en/RAG_zephyr_langchain.ipynb rename to notebooks/en/rag_zephyr_langchain.ipynb From 4c78fd2d84b8fea6131630f91a1f147717f3a939 Mon Sep 17 00:00:00 2001 From: Mishig Davaadorj Date: Thu, 15 Feb 2024 16:35:25 +0100 Subject: [PATCH 2/4] user lowercase --- notebooks/en/_toctree.yml | 10 +++++----- notebooks/en/index.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/notebooks/en/_toctree.yml b/notebooks/en/_toctree.yml index 14e76918..09825b25 100644 --- a/notebooks/en/_toctree.yml +++ b/notebooks/en/_toctree.yml @@ -2,13 +2,13 @@ sections: - local: index title: Open-Source AI Cookbook - - local: FAISS_with_HF_datasets_and_CLIP + - local: faiss_with_hf_datasets_and_clip title: Embedding multimodal data for similarity search - - local: Fine_tuning_Code_LLM_on_single_GPU + - 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 + - local: rag_zephyr_langchain title: Simple RAG using Hugging Face Zephyr and LangChain - - local: advanced_RAG + - local: advanced_rag title: Advanced RAG on HuggingFace documentation using LangChain - - local: RAG_evaluation + - local: rag_evaluation title: RAG Evaluation diff --git a/notebooks/en/index.md b/notebooks/en/index.md index a06b6aff..b9b2a530 100644 --- a/notebooks/en/index.md +++ b/notebooks/en/index.md @@ -7,11 +7,11 @@ applications and solving various machine learning tasks using open-source tools Check out the recently added notebooks: -- [Simple RAG for GitHub issues using Hugging Face Zephyr and LangChain](RAG_zephyr_langchain) -- [Embedding multimodal data for similarity search using 🤗 transformers, 🤗 datasets and FAISS](FAISS_with_HF_datasets_and_CLIP) -- [Fine-tuning a Code LLM on Custom Code on a single GPU](Fine_tuning_Code_LLM_on_single_GPU) -- [RAG Evaluation Using Synthetic data and LLM-As-A-Judge](RAG_evaluation) -- [Advanced RAG on HuggingFace documentation using LangChain](advanced_RAG) +- [Simple RAG for GitHub issues using Hugging Face Zephyr and LangChain](rag_zephyr_langchain) +- [Embedding multimodal data for similarity search using 🤗 transformers, 🤗 datasets and FAISS](faiss_with_hf_datasets_and_clip) +- [Fine-tuning a Code LLM on Custom Code on a single GPU](fine_tuning_code_llm_on_single_gpu) +- [RAG Evaluation Using Synthetic data and LLM-As-A-Judge](rag_evaluation) +- [Advanced RAG on HuggingFace documentation using LangChain](advanced_rag) You can also check out the notebooks in the cookbook's [GitHub repo](https://github.com/huggingface/cookbook). From 6e1197a28ebe4b6cdd4b7fc629c3c67c51044920 Mon Sep 17 00:00:00 2001 From: Mishig Date: Thu, 15 Feb 2024 07:40:07 -0800 Subject: [PATCH 3/4] Update .github/workflows/check_notebooks_lowercase.yml Co-authored-by: Maria Khalusova --- .github/workflows/check_notebooks_lowercase.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check_notebooks_lowercase.yml b/.github/workflows/check_notebooks_lowercase.yml index 040155e3..8b059eb2 100644 --- a/.github/workflows/check_notebooks_lowercase.yml +++ b/.github/workflows/check_notebooks_lowercase.yml @@ -1,4 +1,4 @@ -name: Check nteobook names are lowercase +name: Check notebook names are lowercase on: [push] From 890be77e0bc127d8ae49dd97ac987b837bc02598 Mon Sep 17 00:00:00 2001 From: Mishig Davaadorj Date: Thu, 15 Feb 2024 16:41:03 +0100 Subject: [PATCH 4/4] rm unneeded line --- .github/workflows/check_notebooks_lowercase.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/check_notebooks_lowercase.yml b/.github/workflows/check_notebooks_lowercase.yml index 040155e3..fa6fed90 100644 --- a/.github/workflows/check_notebooks_lowercase.yml +++ b/.github/workflows/check_notebooks_lowercase.yml @@ -21,5 +21,4 @@ jobs: exit 1 else echo "All filenames are lowercase." - exit 0 fi \ No newline at end of file