Prompt Optimizer 项目教程

Prompt Optimizer 项目教程

prompt-optimizer Minimize LLM token complexity to save API costs and model computations. 项目地址: https://gitcode.com/gh_mirrors/pr/prompt-optimizer

1. 项目目录结构及介绍

prompt-optimizer/
├── README.md
├── requirements.txt
├── setup.py
├── prompt_optimizer/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── helper.py
│   ├── tests/
│   │   ├── __init__.py
│   │   ├── test_main.py
│   ├── data/
│   │   ├── prompts.json
│   │   ├── optimized_prompts.json

目录结构说明

• README.md: 项目的介绍文件，包含项目的基本信息、安装步骤和使用说明。
• requirements.txt: 项目依赖的Python包列表。
• setup.py: 用于安装项目的脚本。
• prompt_optimizer/: 项目的主要代码目录。
  • init.py: 使 prompt_optimizer 成为一个Python包。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • utils/: 包含项目中使用的工具函数。
    • helper.py: 工具函数文件。
  • tests/: 包含项目的测试代码。
    • test_main.py: 测试 main.py 的测试文件。
  • data/: 包含项目使用的数据文件。
    • prompts.json: 原始提示数据文件。
    • optimized_prompts.json: 优化后的提示数据文件。

2. 项目启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化项目并执行主要功能。以下是 main.py 的主要内容：

import config
from prompt_optimizer.utils import helper

def main():
    # 读取配置
    config_data = config.load_config()
    
    # 加载数据
    prompts = helper.load_prompts("data/prompts.json")
    
    # 优化提示
    optimized_prompts = helper.optimize_prompts(prompts)
    
    # 保存优化后的提示
    helper.save_prompts(optimized_prompts, "data/optimized_prompts.json")

if __name__ == "__main__":
    main()

功能说明

• 读取配置: 从 config.py 中加载项目的配置信息。
• 加载数据: 从 data/prompts.json 文件中加载原始提示数据。
• 优化提示: 使用 helper.optimize_prompts 函数对提示进行优化。
• 保存优化后的提示: 将优化后的提示保存到 data/optimized_prompts.json 文件中。

3. 项目配置文件介绍

config.py

config.py 文件包含了项目的配置信息，主要用于配置项目的运行参数。以下是 config.py 的主要内容：

def load_config():
    config = {
        "optimization_level": 2,
        "max_prompt_length": 100,
        "allow_duplicates": False
    }
    return config

配置项说明

• optimization_level: 优化级别，数值越高，优化程度越高。
• max_prompt_length: 提示的最大长度，超过此长度的提示将被截断。
• allow_duplicates: 是否允许重复提示，False 表示不允许。

通过以上配置项，可以灵活调整项目的运行参数，以满足不同的需求。

prompt-optimizer Minimize LLM token complexity to save API costs and model computations. 项目地址: https://gitcode.com/gh_mirrors/pr/prompt-optimizer