Code Trans T5 Base Code Documentation Generation Go

🚀 CodeTransモデルによるGoコードドキュメント生成

このモデルは、t5 baseモデルアーキテクチャを用いてGoプログラミング言語で事前学習されたものです。最初はthis repositoryで公開されました。このモデルはトークン化されたGoコード関数で学習されており、トークン化されたGo関数で最も良い性能を発揮します。

🚀 クイックスタート

このセクションでは、CodeTransモデルの概要と基本的な使い方を説明します。

✨ 主な機能

モデルの概要

このCodeTransモデルはt5-baseモデルをベースにしています。独自のSentencePiece語彙モデルを持ち、CodeSearchNet CorpusのGoデータセットを使って単一タスク学習を行っています。

想定される用途と制限

このモデルは、Go関数の説明を生成するために使用できるほか、他のGoコードタスクで微調整することもできます。構文解析されていない、トークン化されていないGoコードでも使用できますが、トークン化されたGoコードを使用すると、性能が向上する可能性があります。

📦 インストール

このモデルを使用するには、Transformersライブラリが必要です。以下のコマンドでインストールできます。

pip install transformers

💻 使用例

基本的な使用法

以下は、TransformersのSummarizationPipelineを使用してこのモデルを使ってGo関数のドキュメントを生成する方法です。

from transformers import AutoTokenizer, AutoModelWithLMHead, SummarizationPipeline

pipeline = SummarizationPipeline(
    model=AutoModelWithLMHead.from_pretrained("SEBIS/code_trans_t5_base_code_documentation_generation_go"),
    tokenizer=AutoTokenizer.from_pretrained("SEBIS/code_trans_t5_base_code_documentation_generation_go", skip_special_tokens=True),
    device=0
)

tokenized_code = "func ( pr * Progress ) needSnapshotAbort ( ) bool { return pr . State == ProgressStateSnapshot && pr . Match >= pr . PendingSnapshot   }"
pipeline([tokenized_code])

この例は、colab notebookで実行できます。

📚 ドキュメント

学習データ

教師あり学習タスクのデータセットは、Linkからダウンロードできます。

評価結果

コードドキュメントタスクにおいて、異なるモデルが異なるプログラミング言語で次のような結果（BLEUスコア）を達成しています。

📄 ライセンス

このモデルは、Ahmed Elnaggar | LinkedIn と Wei Ding | LinkedInによって作成されました。