Issue Label Bot

ショ和ISSSUEラベルボットはもはやライブではありません。それでもコードを表示できますが、関連するインフラストラクチャコストのためにボットを削除しました

コード：「楽しみと利益のために機械学習でGitHubのタスクを自動化する方法」

目次

• 問題ラベルボット
  • 重要なリンク
  • ファイル
• このコードを実行します
  • 環境変数
  • ローカルで実行します
  • サービスとして展開します
• 貢献
  • ロードマップ
  • 参照
• 免責事項

元の著者：@hamelsmu、 @inc0、@jlewi

ラベルボットを発行します

このアプリをGithub Marketplaceからインストールします

Pythonで書かれた機械学習を搭載したGitHubアプリ。このアプリを構築する動機についての議論は、このブログ投稿で説明されています。

問題が開かれた場合、ボットは、ラベルがfeature request 、 bug 、またはquestionであるかどうかを予測し、必要に応じてラベルを自動的に適用します。これが、動作中のボットのスクリーンショットです。

より多くの例をアプリのホームページで見ることができます。予測が不確実な状況では、ボットがラベルを適用しないことに注意する必要があります。詳細については、免責事項セクションを参照してください。

重要なリンク

• ラベルボットホームページを発行します。このボットに関する他の情報と同様に、例の予測を表示する方法を提供します。
• 問題ラベルボットのGitHubアプリページ。アプリをインストールできます。インストールする前に、以下の免責事項を参照してください。

ファイル

• /ノートブック：モデルをトレーニングし、Pythonクライアントを使用してGitHub APIと対話する方法に関するノートブックが含まれています。
• /flask_app：github発行イベントをリッスンし、予測で応答するフラスコアプリのコード。これは、ユーザーが対話する主なアプリケーションです。
• /ARGO：このディレクトリのコードは、MLワークフローをトレーニングおよび展開するためのArgo MLパイプラインの構築に関連しています。
• /展開：このディレクトリには、アプリの展開に役立つファイルが含まれています。
  • DockerFileこれは、フラスコアプリの実行に使用されるコンテナの定義です。このコンテナ用のビルドは、Hamelsmu/MlappのDockerHubでホストされています。
  • Heroku.yml：これは、Herokuへの展開に使用されます。
  • *.yaml：これらのファイルは、Kubernetesの展開に関連しています。

このコードを実行します

前提条件

このリポジトリでコードを利用するには、独自のgithubアプリを登録し、このアプリを希望のリポジトリにインストールし、認証シークレットを保存する必要があります。

まず、GitHub APIとインターフェイスするクライアントとして代わりにPythonを使用するため、「Rubyプログラミング言語」セクションを除いて、この開始ガイドの前提条件セクションを歩きます。

第二に、開発環境をセットアップします。このステップはオプションであるにもかかわらず、Webhook Secretを作成してください。

次に、Postgresデータベースを設定します。 Herokuでこれを無料で行うことができます。詳細な指示（ここから恥知らずに盗まれました）：

1. https://www.heroku.com/に移動し、アカウントをまだ持っていない場合はアカウントを作成します。
2. Herokuのダッシュボードで、「新しい」をクリックして「新しいアプリの作成」を選択します。
3. アプリに名前を付け、[アプリの作成]をクリックします。
4. アプリの「概要」ページで、[アドオンの構成]ボタンをクリックします。
5. ページの「アドオン」セクションで、「Heroku Postgres」を入力して選択します。
6. 「Hobby Dev-無料」計画を選択します。これにより、最大10,000行のデータをサポートする無料のPostgreSQLデータベースにアクセスできます。 [プロビジョニング]をクリックします。
7. 次に、「Heroku Postgres :: Database」リンクをクリックします。
8. これで、データベースの概要ページに載る必要があります。 8つの「設定」をクリックしてから、「資格情報の表示」をクリックします。これは、データベースにログインするために必要な情報です。

最後に、以下に説明するすべての秘密の環境変数を作成する必要があります。

環境変数

1. PRIVATE_KEY ：これは、GitHub APIを使用してアプリとして認証するために使用する秘密鍵です。
2. WEBHOOK_SECRET ：これは、アプリが受信したペイロードが実際にGitHubからであることを確認するために使用されます。これについてはここで説明します。
3. DATABASE_URL ：これは、通常はpostgres://<username>:<password>@<url>:5432/<database_name> postgresqlデータベースのログイン情報を含むURLです。
4. APP_ID ：これは、アプリを登録するときにGitHubが提供する一意の識別子です。
5. FLASK_ENV ：これは通常、 productionまたはdevelopmentいずれかに設定されています。ローカルテストにはdeploymentを使用する必要があります。
6. PORT ：これは、アプリが提供するポートです。 Herokuに展開する場合、Herokuはアプリを構築するときにこの変数を独自の価値でオーバーライドすることに注意してください。ローカル開発のために、これがポートSMEEが提供しているポートと一致するようにしたいと思うでしょう。
7. APP_URL ：これは、問題のコメントのリンクとしてユーザーに提供されるアプリのホームページのURLです。これを現地開発のために任意の価値に設定できます。

注：ZSHを使用している場合、dotenvプラグインは環境変数の管理に役立ちます。

ローカルで実行します

1. 依存関係をインストール：要件を仮想環境にインストールします。 pipenvを使用している場合、このリポジトリのルートにpipenv install 。

2. Flaskアプリを実行：このリポジトリのルートからpython flask_app/app.pyを実行します。これを機能させるには、環境変数セクションで説明されているように、環境変数を正しく設定する必要があります。

3. オプション-Dockerコンテナとしてアプリを実行します。問題ラベルボットを提供するDockerコンテナは、このリポジトリのルートからコマンドbash script/bootstrapで構築できます。このスクリプトは、 hamelsmu/mlappという名前のDocker画像を構築します。これはDockerHubでも入手できます。テストのためにDockerコンテナをローカルに実行する場合は、実行時に必要な環境変数をDockerコンテナに渡すだけでなく、アプリに必要なポートを公開する必要があります。 Dockerの使用に関するリソースについては、参照セクションを参照してください。

サービスとして展開します

このリポジトリの資産を使用すると、Heroku（より簡単）またはKubernetesクラスター（より高度）に展開できます。

Herokuでは、秘密を構成変数として渡すことができます。さらに、このドキュメントでは、Kubernetesで秘密を設定する方法について説明しています。アプリを公開しようとしている場合は、環境変数FLASK_ENV productionに設定してください。

貢献

あらゆる形態の貢献を歓迎します。特に以下に興味があります。

• バグ修正
• 拡張機能または追加機能
• モデルの改善、またはトレーニングに使用されるデータセットの拡張。

ロードマップ

このプロジェクトの著者は、近い将来に次の機能を追加することに興味があります。

• ラベルセットに属していないアイテムのより良いラベルとネガティブサンプルを構築して、さらに改善を促進します。
• Fastaiのツールを使用して探索します。
  • マルチヘッドの注意など、最先端のアーキテクチャ
  • 転送学習を利用して、一意のラベルを予測し、/または精度を向上させます。
• GitHubアクションを使用して、このコードの自動展開をトリガーします。
• アルゴパイプラインのモデルパイプラインオーケストレーション。

参照

• このリポジトリと関連するチュートリアルのコードは、Dockerに精通しています。このブログ投稿では、データサイエンティスト向けのDockerへの穏やかな紹介を提供しています。

• 機械学習とパブリックGitHubデータセットを使用して構築できる他のデータ製品のインスピレーションが必要ですか？これらの例を参照してください：

  • GitHubの問題の要約と推奨。
  • 自然言語セマンティックコード検索。

• フラスコの優れたコース：Harvardx CS50 Web。

• 機械学習と深い学習のためのFastaiによるMOOCS。

免責事項

Issue-Label Botは、教育およびデモンストレーションのみを目的としています。私たちの目標は、コミュニティに最小限の作業例を可能な限り最小限の量で提供することでした。したがって、実証されたモデルには改善からの大きな余地があると考えています。さらに、このアプリは公開リポジトリでのみ機能し、プライベートリポジトリにインストールされた場合は何もしません。