The_Prompt_Report
1.0.0
生成人工智能（Genai）系統正在越來越多地部署在行業和研究環境的各個部分。開發人員和最終用戶通過使用提示或提示工程與這些系統進行交互。雖然提示是一個廣泛而高度研究的概念，但術語存在衝突，並且對由於該地區的納西奇（Nascency）的迅速構成的構成構成的本體論差異很差。該存儲庫是提示報告的代碼，我們的研究通過組裝提示技術並分析其使用的分類法來建立對提示的結構化理解。該代碼允許對論文，數據收集和實驗運行進行自動審查。我們的數據集可在擁抱面上可用，我們的論文可在arxiv.org上找到。信息也可以在我們的網站上找到。
克隆後，從root運行pip install -r requirements.txt
在root稱為.env 。
對於Openai：https：//platform.openai.com/docs/quickstart
為了擁抱面孔：https：//huggingface.co/docs/hub/security-tokens，也運行huggingface-cli login
對於語義學者：https：//www.semanticscholar.org/product/api#api-key
使用參考example.env文件填寫您的API鍵/令牌。
OPENAI_API_KEY=sk.-...
SEMANTIC_SCHOLAR_API_KEY=...
HF_TOKEN=...
然後加載.env文件，鍵入：
pip install pytest-dotenv
您還可以選擇通過以下操作來更新ENV文件：
py.test --envfile path/to/.env
如果您有多個.env文件，請在pytest config文件夾中創建一個新的env_files，然後鍵入：
env_files =
.env
.test.env
.deploy.env
腳本main.py調用必要的功能，以下載所有論文，重複刪除並過濾它們，然後運行所有實驗。
存儲庫的核心位於src/prompt_systematic_review中。 config_data.py腳本包含對於運行實驗和節省時間很重要的配置。您可以在main.py中看到這些選項中的一些。
The source folder is divided into 4 main sections: 3 scripts ( automated_review.py , collect_papers.py , config_data.py ) that deal with collecting the data and running the automated review, the utils folder that contains utility functions that are used throughout the repository, the get_papers folder that contains the scripts to download the papers, and the experiments folder that contains the scripts to run the實驗。
根本上有一個data文件夾。它預先加載了一些用於實驗的數據，但是數據集的大部分可以通過運行main.py或通過從擁抱面下載數據來生成。在data/experiments_output中，實驗的結果保存在數據/實驗中。
值得注意的是，自動化評論/刮擦過程中使用的關鍵字在src/prompt_systematic_review/utils/keywords.py中。任何希望運行自動化評論的人都可以將這些關鍵字調整為在該文件中的喜歡。
git clone https://github.com/trigaten/Prompt_Systematic_Review.git && cd Prompt_Systematic_Review
pip install -r requirements.txt
# create a .env file with your API keys
nano .env
git lfs install
git clone https://huggingface.co/datasets/PromptSystematicReview/ThePromptReport
mv ThePromptReport/ * data/
python main.py運行main.py將下載論文，運行自動化評論並運行實驗。但是，如果您想節省時間並僅運行實驗，則可以從擁抱面孔下載數據，並將紙文件夾和數據集中的所有CSV文件移動到數據文件夾中（應該看起來像data/papers/*.pdf和data/master_papers.csv等）。相應地調整Main.py。
每個實驗腳本都有一個run_experiment函數，該功能在main.py中稱為。 run_experiment功能負責運行實驗並保存結果。但是，每個腳本可以通過僅運行python src/prompt_systematic_review/experiments/<experiment_name>.py來單獨運行。
有一個實驗， graph_internal_references ，由於與並行性的怪異問題，它可以從根本上作為單個腳本進行運行。為了避免在其他實驗中引起問題，它是在experiments/__init__.py中列出的列表底部的最後一次運行。
