diff --git a/.github/workflows/check_notebooks_lowercase.yml b/.github/workflows/check_notebooks_lowercase.yml new file mode 100644 index 00000000..ee77586b --- /dev/null +++ b/.github/workflows/check_notebooks_lowercase.yml @@ -0,0 +1,24 @@ +name: Check notebook 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." + fi \ No newline at end of file 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/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/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). 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