docs: Update README to enhance clarity and add environment setup instructions

This commit is contained in:
neverbiasu
2025-01-18 19:05:58 +08:00
parent 329be39904
commit fa22debff4
2 changed files with 16 additions and 4 deletions
+16 -4
View File
@@ -1,9 +1,18 @@
# ComfyUI-Dashscope
This project adapts the dashscope([aliyun-bailian](https://bailian.console.aliyun.com)) api into ComfyUI.
This project integrates the Dashscope API from [Aliyun Bailian](https://bailian.console.aliyun.com) into ComfyUI.
![vlm example](assets/vlm.png)
Refer to this example workflow for a quick start.
## Requirements
### Environment Setup
Set the system environment variable `DASHSCOPE_API_KEY` on your computer. Refer to [this guide](https://help.aliyun.com/zh/model-studio/developer-reference/configure-api-key-through-environment-variables?spm=a2c4g.11186623.help-menu-2400256.d_3_1.3f8a1078V8zfae&scm=20140722.H_2803795._.OR_help-T_cn~zh-V_1#e4cd73d544i3r) for instructions on configuring the Dashscope API key based on your system. You can view your API key [here](https://bailian.console.aliyun.com/?apiKey=1#/api-key).
### Installation
Install the necessary Python dependencies with:
```sh
@@ -12,8 +21,11 @@ pip install -r requirements.txt
## Models
You can find LLM models or other AI models in [models](./models.md).
You can find LLM models or other AI models in [models documentation](./models.md).
### Contribution
## Contribution
Thank you for considering contributions! Fork the repository, make changes, and send a pull request for review and merging.
We welcome contributions! Please fork the repository, make your changes, and submit a pull request for review.
## License
This project is licensed under the MIT License. See the LICENSE file for details.
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 1021 KiB