No project description provided
Project description
加入开发
依赖管理:Poetry与env/dependency管理方法
这个项目使用 Poetry 来管理依赖。
注意:在安装Poetry之前,如果您使用Conda,请创建并激活一个新的Conda env(例如,
conda create-n chatchat python=3.9
)
Install Poetry: documentation on how to install it.
注意: 如果您使用 Conda 或 Pyenv 作为您的环境/包管理器,在安装Poetry之后, 使用如下命令使Poetry使用virtualenv python environment (
poetry config virtualenvs.prefer-active-python true
)
本地开发环境安装
- 选择主项目目录
cd chatchat
- 安装chatchat依赖(for running chatchat lint\tests):
poetry install --with lint,test
格式化和代码检查
在提交PR之前,请在本地运行以下命令;CI系统也会进行检查。
代码格式化
本项目使用ruff进行代码格式化。
要对某个库进行格式化,请在相应的库目录下运行相同的命令:
cd {model-providers|chatchat|chatchat-server|chatchat-frontend}
make format
此外,你可以使用format_diff命令仅对当前分支中与主分支相比已修改的文件进行格式化:
make format_diff
当你对项目的一部分进行了更改,并希望确保更改的部分格式正确,而不影响代码库的其他部分时,这个命令特别有用。
开始使用
环境配置完成后,启动步骤为先启动chatchat-server,然后启动chatchat-frontend。 chatchat可通过pypi安装一键启动,您也可以选择使用源码启动。
pypi安装一键启动
- 安装chatchat
pip install chatchat
- 复制配置文件
cd chatchat-server/chatchat
python copy_config_example.py
当项目安装完成,配置这个
model_providers.yaml
文件,即可完成自定义平台加载注意: 在您配置平台之前,请确认平台依赖完整,例如智谱平台,您需要安装智谱sdk
pip install zhipuai
详细配置请参考README.md
- 启动服务
cd chatchat-server/
python -m chatchat.startup -a
源码启动chatchat-server
- 初始化依赖
cd chatchat-server/chatchat
python copy_config_example.py
- 初始化仓库
cd chatchat-server/chatchat
python init_database.py
- 启动服务
python chatchat-server/chatchat/startup.py -a
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for langchain_chatchat-0.3.0.20240506.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7512eedec8b2403b5d697adb1d7ed1b8c3c9133b0bd68a634f1fd75f48e9f243 |
|
MD5 | 89d314ad30e9eef2876ea0681ddebfdd |
|
BLAKE2b-256 | 7f8a310e1004c422113d921071b356eea864240d4f1276a1507fffc51413d325 |
Hashes for langchain_chatchat-0.3.0.20240506-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a5914870561deffd61fe31851f113642860a0b379535c6a8d0155bdce4a2c67 |
|
MD5 | 7862e98c92ea96f5a34ada88a4da46eb |
|
BLAKE2b-256 | 3fed4ea7129e88ef3ae422a7f5802ff1e6cd7f593d1d3e557fc5a1e9baccb8c1 |