Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check notebooks are lowercase #22

Merged
merged 5 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/check_notebooks_lowercase.yml
Original file line number Diff line number Diff line change
@@ -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
10 changes: 5 additions & 5 deletions notebooks/en/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
File renamed without changes.
10 changes: 5 additions & 5 deletions notebooks/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
File renamed without changes.
Loading