mcqgen

LangChain と HuggingFace Hub API を使用した MCQ ジェネレーター アプリケーション

Streamlit を使用した MCQ Generator は、ユーザーが PDF またはテキスト ファイルをアップロードし、質問の数、件名、論調を指定し、提供された入力に基づいて多肢選択質問 (MCQ) を生成できる Web アプリケーションです。このアプリケーションは、自然言語処理に Hugging Face API オープン ソース言語モデルを利用し、生成されたクイズの複雑さに関するフィードバックを提供します。

このアプリケーションを実行するには:

• このリポジトリをダウンロードし、コマンド pip install -rrequirements.txt を使用して前提条件ライブラリをインストールします。
• コマンド streamlit run streamlitapp.py を実行してアプリケーションを実行します。
• PS: mcqGen.py ファイルに独自の HUGGING_FACE_TOKEN を指定する必要があります。

特徴

• ファイルのアップロード:ユーザーは、MCQ が生成されるテキストを含む PDF またはテキスト ファイルをアップロードできます。
• 動的入力:ユーザーは、生成される MCQ の質問の数、件名、トーンを指定できます。
• リアルタイム フィードバック:生成されたクイズの複雑さに関するリアルタイムのフィードバックを提供し、改善を提案します。
• 表形式表示:生成された MCQ を表形式で表示し、読みやすくします。

前提条件

• Python 3.x
• ストリームライト付きライブラリ
• ラングチェーンライブラリ
• HUGGING_FACE_TOKEN

インストール

1. リポジトリのクローンを作成します。

   git clone https://github.com/4darsh-Dev/mcqgen.git

2 必要な依存関係をインストールします。

pip install -r requirements.txt

3. 環境変数を設定します。

   • ルート ディレクトリに .env ファイルを作成します。

   • OpenAI API キーを .env ファイルに追加します。

     HF_API_TOKEN=YOUR_TOKEN_HERE

4. 仮想環境にローカル パッケージをインストールします。

   python setup.py install

デモ

近日公開...

使用法

1. Streamlit アプリケーションを実行します。

   streamlit run main.py

2. Web ブラウザでアプリケーションにアクセスします。

3. PDF またはテキスト ファイルをアップロードし、質問数、件名、論調を指定して、[MCQ を作成] ボタンをクリックします。

4. 生成された MCQ と提供されたレビュー フィードバックを表示します。

ロギング

• すべてのログはlogsディレクトリに保存されます。
• 各ログ ファイルには、作成日を示すタイムスタンプが付いた名前が付けられます。