Streamlit LLM 示例项目教程

1. 项目目录结构及介绍

llm-examples/
├── devcontainer/
├── github/workflows/
├── pages/
├── .gitignore
├── .pre-commit-config.yaml
├── ruff.toml
├── Chatbot.py
├── LICENSE
├── README.md
├── app_test.py
├── requirements-dev.txt
├── requirements.txt

目录结构介绍

• devcontainer/: 包含开发容器的配置文件。
• github/workflows/: 包含GitHub Actions的工作流配置文件。
• pages/: 包含项目的页面文件。
• .gitignore: Git忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置文件。
• ruff.toml: Ruff代码检查工具的配置文件。
• Chatbot.py: 项目的启动文件，包含Chatbot的实现。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• app_test.py: 项目的测试文件。
• requirements-dev.txt: 开发环境的依赖文件。
• requirements.txt: 生产环境的依赖文件。

2. 项目启动文件介绍

Chatbot.py

Chatbot.py 是项目的启动文件，主要用于启动Chatbot应用。该文件包含了Chatbot的核心逻辑和用户交互界面。

import streamlit as st
from streamlit_chat import message

def main():
    st.title("Streamlit Chatbot Example")
    message("Hello, I'm your chatbot!")

if __name__ == "__main__":
    main()

启动步骤

1. 安装依赖：

   pip install -r requirements.txt
   

2. 启动应用：

   streamlit run Chatbot.py
   

3. 项目配置文件介绍

ruff.toml

ruff.toml 是Ruff代码检查工具的配置文件，用于配置代码检查规则。

[tool.ruff]
line-length = 88
select = ["E", "F"]
ignore = ["W292"]

requirements.txt

requirements.txt 是项目的依赖文件，包含了项目运行所需的所有Python包。

streamlit
streamlit-chat

.pre-commit-config.yaml

.pre-commit-config.yaml 是预提交钩子的配置文件，用于在提交代码前自动执行代码检查和格式化。

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.3.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-added-large-files

通过以上配置文件，可以确保项目的代码质量和一致性。