Codet5 Base Generate Docstrings For Python Condensed

🚀 codet5-base-為Python生成精簡文檔字符串

本模型旨在針對Python函數輸入，精準預測對應的文檔字符串輸出，有效解決代碼註釋生成難題，提升代碼的可讀性和可維護性。

🚀 快速開始

本模型是 Salesforce/codet5-base 在特定數據集上的微調版本。它在評估集上取得了以下結果：

• 損失值：0.6199
• Rouge1：0.5017
• Rouge2：0.374
• Rougel：0.4866
• Rougelsum：0.4864
• 生成長度：13.8909

✨ 主要特性

此模型專注於預測函數的文檔字符串（輸出），以函數作為輸入。若想了解其創建過程的更多信息，請查看以下鏈接：https://github.com/DunnBC22/NLP_Projects/blob/main/Generate%20Docstrings/Smol%20Dataset/Code_T5_Project-Base%20Checkpoint.ipynb

📚 詳細文檔

預期用途與限制

本模型旨在展示使用技術解決複雜問題的能力。

訓練和評估數據

數據集來源：calum/the-stack-smol-python-docstrings（來自HuggingFace Datasets；https://huggingface.co/datasets/calum/the-stack-smol-python-docstrings）

訓練過程

訓練超參數

訓練期間使用了以下超參數：

• 學習率：2e - 05
• 訓練批次大小：16
• 評估批次大小：16
• 隨機種子：42
• 優化器：Adam（β1 = 0.9，β2 = 0.999，ε = 1e - 08）
• 學習率調度類型：線性
• 訓練輪數：2

訓練結果

框架版本

• Transformers 4.27.4
• Pytorch 2.0.0
• Datasets 2.11.0
• Tokenizers 0.13.3

📄 許可證

本模型採用 Apache 2.0 許可證。