chore:change the name of CoTDataGenerator and update the share link o…

…f cook… (#1385) Co-authored-by: Wendong <[email protected]>
camel-ai · Jan 2, 2025 · 1e09067 · 1e09067
1 parent 4b39748
commit 1e09067
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -325,8 +325,8 @@ Practical guides and tutorials for implementing specific functionalities in CAME
 | **[Customer Service Discord Bot with Agentic RAG](https://docs.camel-ai.org/cookbooks/customer_service_Discord_bot_with_agentic_RAG.html)** |  Learn how to build a robust customer service bot for Discord using Agentic RAG. |
 | **[Create AI Agents that work with your PDFs using Chunkr & Mistral AI](https://docs.camel-ai.org/cookbooks/agent_with_chunkr_for_pdf_parsing.html)** | Learn how to create AI agents that work with your PDFs using Chunkr and Mistral AI. |
 | **[Data Gen with Real Function Calls and Hermes Format](https://docs.camel-ai.org/cookbooks/data_gen_with_real_function_calls_and_hermes_format.html)** |  Explore how to generate data with real function calls and the Hermes format. |
-| **[CoT data Generation with CAMEL and Upload Data to Huggingface](https://docs.camel-ai.org/cookbooks/CoTdatagen_with_CAMEL_And_Upload_Data_To_Huggingface.html)** | Uncover how to generate O1 data with CAMEL and seamlessly upload it to Huggingface. |
-| **[CoTdatagen with CAMEL And Sft Qwen With Unsolth And Upload Data And Model To Huggingface](https://docs.camel-ai.org/cookbooks/CoTdatagen_with_CAMEL_And_Sft_Qwen_With_Unsolth_And_Upload_Data_And_Model_To_Huggingface.html)** | Discover how to generate O1 data using CAMEL and SFT Qwen with Unsolth, and seamlessly upload your data and model to Huggingface. |
+| **[CoT Data Generation and Upload Data to Huggingface](https://docs.camel-ai.org/cookbooks/cot_data_gen_upload_to_huggingface.html)** | Uncover how to generate CoT data with CAMEL and seamlessly upload it to Huggingface. |
+| **[CoT Data Generation and SFT Qwen with Unsolth, Uploading Data and Model to Hugging Face](https://docs.camel-ai.org/cookbooks/cot_data_gen_sft_qwen_unsolth_upload_huggingface.html)** | Discover how to generate CoT data using CAMEL and SFT Qwen with Unsolth, and seamlessly upload your data and model to Huggingface. |
 | **[Customer Service Discord Bot with Agentic RAG supports local model deployment](https://docs.camel-ai.org/cookbooks/customer_service_Discord_bot_using_local_model_with_agentic_RAG.html)** | Learn how to build a robust customer service bot for Discord using Agentic RAG which supports local deployment. |
 
 ## Utilize Various LLMs as Backends

diff --git a/...pload_Data_And_Model_To_Huggingface.ipynb → ...sft_qwen_unsolth_upload_huggingface.ipynb b/...pload_Data_And_Model_To_Huggingface.ipynb → ...sft_qwen_unsolth_upload_huggingface.ipynb
@@ -7,7 +7,7 @@
         "id": "d80bea45"
       },
       "source": [
-        "# Cotdatagen with CAMEL And Sft Qwen With Unsolth And Upload Data And Model To Huggingface"
+        "# CoTdatagen with CAMEL And Sft Qwen With Unsolth And Upload Data And Model To Huggingface"
       ]
     },
     {
@@ -17,7 +17,7 @@
         "id": "MgAnJZTCCNDl"
       },
       "source": [
-        "You can also check this cookbook in colab [here](https://drive.google.com/file/d/1AnpeyVcYpCTa8oN1Po20fIXya-pv9A1Q/view?usp=sharing)  (Use the colab share link)"
+        "You can also check this cookbook in colab [here](https://drive.google.com/file/d/1lbcDNvzB6O50R9D3rOKefta1eyBd_baI/view?usp=sharing)  (Use the colab share link)"
       ]
     },
     {
@@ -29,12 +29,12 @@
       "source": [
         "\n",
         "\n",
-        "This notebook demonstrates how to set up and leverage CAMEL's **CotDataGenerator** for generating high-quality question-answer pairs like o1 thinking data, fine-tuning a language model using Unsloth, and uploading the results to Hugging Face.\n",
+        "This notebook demonstrates how to set up and leverage CAMEL's **CoTDataGenerator** for generating high-quality question-answer pairs like o1 thinking data, fine-tuning a language model using Unsloth, and uploading the results to Hugging Face.\n",
         "\n",
         "In this notebook, you'll explore:\n",
         "\n",
         "- **CAMEL**: A powerful multi-agent framework that enables SFT data generation and multi-agent role-playing scenarios, allowing for sophisticated AI-driven tasks.\n",
-        "- **CotDataGenerator**: A tool for generating like o1 thinking data.\n",
+        "- **CoTDataGenerator**: A tool for generating like o1 thinking data.\n",
         "- **Unsloth**: An efficient library for fine-tuning large language models with LoRA (Low-Rank Adaptation) and other optimization techniques.\n",
         "- **Hugging Face Integration**: Uploading datasets and fine-tuned models to the Hugging Face platform for sharing.\n"
       ]
@@ -402,7 +402,7 @@
         "lines_to_next_cell": 2
       },
       "source": [
-        "## Create an instance of CotDataGenerator"
+        "## Create an instance of CoTDataGenerator"
       ]
     },
     {
@@ -2411,10 +2411,10 @@
       },
       "source": [
         "\n",
-        "Through this notebook demonstration, we showcased how to use the CotDataGenerator from the CAMEL framework to generate high-quality question-answer data and efficiently fine-tune language models using the Unsloth library. The entire process covers the end-to-end workflow from data generation, model fine-tuning, to model deployment, demonstrating how to leverage modern AI tools and platforms to build and optimize question-answering systems.\n",
+        "Through this notebook demonstration, we showcased how to use the CoTDataGenerator from the CAMEL framework to generate high-quality question-answer data and efficiently fine-tune language models using the Unsloth library. The entire process covers the end-to-end workflow from data generation, model fine-tuning, to model deployment, demonstrating how to leverage modern AI tools and platforms to build and optimize question-answering systems.\n",
         "\n",
         "## Key Takeaways:\n",
-        "Data Generation: Using CotDataGenerator from CAMEL, we were able to generate high-quality question-answer data similar to o1 thinking. This data can be used for training and evaluating question-answering systems.\n",
+        "Data Generation: Using CoTDataGenerator from CAMEL, we were able to generate high-quality question-answer data similar to o1 thinking. This data can be used for training and evaluating question-answering systems.\n",
         "\n",
         "Model Fine-Tuning: With the Unsloth library, we were able to fine-tune large language models with minimal computational resources. By leveraging LoRA (Low-Rank Adaptation) technology, we only needed to update a small portion of the model parameters, significantly reducing the resources required for training.\n",
         "\n",

diff --git a/...AMEL_And_Upload_Data_To_Huggingface.ipynb → ...t_data_gen_upload_to_huggingface.py.ipynb b/...AMEL_And_Upload_Data_To_Huggingface.ipynb → ...t_data_gen_upload_to_huggingface.py.ipynb
@@ -7,7 +7,7 @@
         "id": "d80bea45"
       },
       "source": [
-        "# Cot Data Generation with CAMEL and Upload Data to Huggingface"
+        "# CoT Data Generation with CAMEL and Upload Data to Huggingface"
       ]
     },
     {
@@ -29,12 +29,12 @@
       "source": [
         "\n",
         "\n",
-        "This notebook demonstrates how to set up and leverage CAMEL's **CotDataGenerator** for generating high-quality question-answer pairs like o1 thinking data, uploading the data to Hugging Face.\n",
+        "This notebook demonstrates how to set up and leverage CAMEL's **CoTDataGenerator** for generating high-quality question-answer pairs like o1 thinking data, uploading the data to Hugging Face.\n",
         "\n",
         "In this notebook, you'll explore:\n",
         "\n",
         "- **CAMEL**: A powerful multi-agent framework that enables SFT data generation and multi-agent role-playing scenarios, allowing for sophisticated AI-driven tasks.\n",
-        "- **CotDataGenerator**: A tool for generating like o1 thinking data.\n",
+        "- **CoTDataGenerator**: A tool for generating like o1 thinking data.\n",
         "\n",
         "- **Hugging Face Integration**: Uploading datasets  to the Hugging Face platform for sharing\n"
       ]
@@ -378,7 +378,7 @@
         "lines_to_next_cell": 2
       },
       "source": [
-        "## Create an instance of CotDataGenerator"
+        "## Create an instance of CoTDataGenerator"
       ]
     },
     {
@@ -1000,10 +1000,10 @@
       "source": [
         "\n",
         "\n",
-        "This cookbook demonstrates the process of using **CAMEL's CotDataGenerator** to create high-quality question-answer pairs, similar to o1 thinking data. The notebook covers the following steps:\n",
+        "This cookbook demonstrates the process of using **CAMEL's CoTDataGenerator** to create high-quality question-answer pairs, similar to o1 thinking data. The notebook covers the following steps:\n",
         "\n",
         "1. **Setup**: Installation of the `camel-ai` library and configuration of the OpenAI API key.\n",
-        "2. **Data Generation**: Utilization of the `CotDataGenerator` to generate answers for predefined questions using llm model.\n",
+        "2. **Data Generation**: Utilization of the `CoTDataGenerator` to generate answers for predefined questions using llm model.\n",
         "3. **Data Transformation**: Conversion of the generated Q&A data into a format compliant with the Alpaca training data schema.\n",
         "4. **Upload to Hugging Face**: Integration with Hugging Face to upload the transformed dataset, including the creation of a dataset card and metadata.\n",
         "\n",
@@ -1035,7 +1035,7 @@
       "notebook_metadata_filter": "-all"
     },
     "kernelspec": {
-      "display_name": "o1data",
+      "display_name": "camel-ai-1zf4chC7-py3.11",
       "language": "python",
       "name": "python3"
     },
@@ -1049,7 +1049,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.11"
+      "version": "3.11.5"
     }
   },
   "nbformat": 4,

diff --git a/docs/index.rst b/docs/index.rst
@@ -78,8 +78,8 @@ Main Documentation
    cookbooks/customer_service_Discord_bot_using_local_model_with_agentic_RAG.ipynb
    cookbooks/data_gen_with_real_function_calls_and_hermes_format.ipynb
    cookbooks/agent_with_chunkr_for_pdf_parsing.ipynb
-   cookbooks/CoTdatagen_with_CAMEL_And_Upload_Data_To_Huggingface.ipynb
-   cookbooks/CoTdatagen_with_CAMEL_And_Sft_Qwen_With_Unsolth_And_Upload_Data_And_Model_To_Huggingface.ipynb
+   cookbooks/cot_data_gen_upload_to_huggingface.py.ipynb
+   cookbooks/cot_data_gen_sft_qwen_unsolth_upload_huggingface.ipynb
 
 .. toctree::
    :maxdepth: 1