Skip to content

Improve the Chinese Readme to synchronize with the English Readme. #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

# 🕷️ ScrapeGraphAI: You Only Scrape Once
[English](https://github.com/VinciGit00/Scrapegraph-ai/blob/main/README.md) | [中国人](https://github.com/VinciGit00/Scrapegraph-ai/blob/main/docs/chinese.md)
[English](https://github.com/VinciGit00/Scrapegraph-ai/blob/main/README.md) | [中文](https://github.com/VinciGit00/Scrapegraph-ai/blob/main/docs/chinese.md)

[![Downloads](https://static.pepy.tech/badge/scrapegraphai)](https://pepy.tech/project/scrapegraphai)
[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
Expand Down
105 changes: 58 additions & 47 deletions docs/chinese.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,36 @@ Scrapegraph-ai 的参考页面可以在 PyPI 的官方网站上找到: [pypi](ht
```bash
pip install scrapegraphai
```
注意: 建议在虚拟环境中安装该库,以避免与其他库发生冲突 🐱
**注意**: 建议在虚拟环境中安装该库,以避免与其他库发生冲突 🐱

🔍 演示
## 🔍 演示

官方 Streamlit 演示:


[![My Skills](https://skillicons.dev/icons?i=react)](https://scrapegraph-ai-web-dashboard.streamlit.app)

在 Google Colab 上直接尝试:

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1sEZBonBMGP44CtO6GQTwAlL0BGJXjtfd?usp=sharing)

## 📖 文档

ScrapeGraphAI 的文档可以在这里找到
ScrapeGraphAI 的文档可以在[这里](https://scrapegraph-ai.readthedocs.io/en/latest/)找到

还可以查看 Docusaurus 这里
还可以查看 Docusaurus 的[版本](https://scrapegraph-doc.onrender.com/)

## 💻 用法

有三种主要的爬取管道可用于从网站(或本地文件)提取信息:

SmartScraperGraph: 单页爬虫,只需用户提示和输入源;
SearchGraph: 多页爬虫,从搜索引擎的前 n 个搜索结果中提取信息;
SpeechGraph: 单页爬虫,从网站提取信息并生成音频文件。
SmartScraperMultiGraph: 多页爬虫,给定一个提示
可以通过 API 使用不同的 LLM,如 OpenAIGroqAzure 和 Gemini,或者使用 Ollama 的本地模型。
- `SmartScraperGraph`: 单页爬虫,只需用户提示和输入源;
- `SearchGraph`: 多页爬虫,从搜索引擎的前 n 个搜索结果中提取信息;
- `SpeechGraph`: 单页爬虫,从网站提取信息并生成音频文件。
- `SmartScraperMultiGraph`: 多页爬虫,给定一个提示
可以通过 API 使用不同的 LLM,如 **OpenAI**,**Groq**,**Azure****Gemini**,或者使用 **Ollama** 的本地模型。

案例 1: 使用本地模型的 SmartScraper
请确保已安装 Ollama 并使用 ollama pull 命令下载模型。
### 案例 1: 使用本地模型的 SmartScraper
请确保已安装 [Ollama](https://ollama.com/) 并使用 `ollama pull` 命令下载模型。

``` python
from scrapegraphai.graphs import SmartScraperGraph
Expand All @@ -68,23 +70,24 @@ graph_config = {
}

smart_scraper_graph = SmartScraperGraph(
prompt="列出所有项目及其描述",
prompt="List me all the projects with their descriptions",
# 也接受已下载的 HTML 代码的字符串
source="https://perinim.github.io/projects",
config=graph_config
)

result = smart_scraper_graph.run()
print(result)
```
```

输出将是一个包含项目及其描述的列表,如下所示:

python
Copia codice
{'projects': [{'title': 'Rotary Pendulum RL', 'description': '开源项目,旨在使用 RL 算法控制现实中的旋转摆'}, {'title': 'DQN Implementation from scratch', 'description': '开发了一个深度 Q 网络算法来训练简单和双摆'}, ...]}
案例 2: 使用混合模型的 SearchGraph
我们使用 Groq 作为 LLM,使用 Ollama 作为嵌入模型。
```python
{'projects': [{'title': 'Rotary Pendulum RL', 'description': 'Open Source project aimed at controlling a real life rotary pendulum using RL algorithms'}, {'title': 'DQN Implementation from scratch', 'description': 'Developed a Deep Q-Network algorithm to train a simple and double pendulum'}, ...]}
```

### 案例 2: 使用混合模型的 SearchGraph
我们使用 **Groq** 作为 LLM,使用 **Ollama** 作为嵌入模型。

```python
from scrapegraphai.graphs import SearchGraph
Expand All @@ -105,7 +108,7 @@ graph_config = {

# 创建 SearchGraph 实例
search_graph = SearchGraph(
prompt="列出所有来自基奥贾的传统食谱",
prompt="List me all the traditional recipes from Chioggia",
config=graph_config
)

Expand All @@ -118,9 +121,12 @@ print(result)

```python
{'recipes': [{'name': 'Sarde in Saòre'}, {'name': 'Bigoli in salsa'}, {'name': 'Seppie in umido'}, {'name': 'Moleche frite'}, {'name': 'Risotto alla pescatora'}, {'name': 'Broeto'}, {'name': 'Bibarasse in Cassopipa'}, {'name': 'Risi e bisi'}, {'name': 'Smegiassa Ciosota'}]}
案例 3: 使用 OpenAI 的 SpeechGraph
您只需传递 OpenAI API 密钥和模型名称。
```

### 案例 3: 使用 OpenAI 的 SpeechGraph

您只需传递 OpenAI API 密钥和模型名称。

```python
from scrapegraphai.graphs import SpeechGraph

Expand All @@ -142,7 +148,7 @@ graph_config = {
# ************************************************

speech_graph = SpeechGraph(
prompt="详细总结这些项目并生成音频。",
prompt="Make a detailed audio summary of the projects.",
source="https://perinim.github.io/projects/",
config=graph_config,
)
Expand All @@ -152,36 +158,38 @@ print(result)
```
输出将是一个包含页面上项目摘要的音频文件。

## 🤝 贡献
## 赞助商

欢迎贡献并加入我们的 Discord 服务器与我们讨论改进和提出建议!
<div style="text-align: center;">
<a href="https://serpapi.com?utm_source=scrapegraphai">
<img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/serp_api_logo.png" alt="SerpAPI" style="width: 10%;">
</a>
<a href="https://dashboard.statproxies.com/?refferal=scrapegraph">
<img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/transparent_stat.png" alt="Stats" style="width: 15%;">
</a>
</div>

请参阅贡献指南。
## 🤝 贡献

欢迎贡献并加入我们的 Discord 服务器与我们讨论改进和提出建议!

请参阅[贡献指南](https://github.com/VinciGit00/Scrapegraph-ai/blob/main/CONTRIBUTING.md)。

[![My Skills](https://skillicons.dev/icons?i=discord)](https://discord.gg/uJN7TYcpNa)
[![My Skills](https://skillicons.dev/icons?i=linkedin)](https://www.linkedin.com/company/scrapegraphai/)
[![My Skills](https://skillicons.dev/icons?i=twitter)](https://twitter.com/scrapegraphai)


📈 路线图
## 📈 路线图

查看项目路线图这里! 🚀
在[这里](https://github.com/VinciGit00/Scrapegraph-ai/blob/main/docs/README.md)查看项目路线图! 🚀

想要以更互动的方式可视化路线图?请查看 markmap 通过将 markdown 内容复制粘贴到编辑器中进行可视化!
想要以更互动的方式可视化路线图?请查看 [markmap](https://markmap.js.org/repl) 通过将 markdown 内容复制粘贴到编辑器中进行可视化!

## ❤️ 贡献者
[![Contributors](https://contrib.rocks/image?repo=VinciGit00/Scrapegraph-ai)](https://github.com/VinciGit00/Scrapegraph-ai/graphs/contributors)


赞助商

<div style="text-align: center;">
<a href="https://serpapi.com?utm_source=scrapegraphai">
<img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/serp_api_logo.png" alt="SerpAPI" style="width: 10%;">
</a>
<a href="https://dashboard.statproxies.com/?refferal=scrapegraph">
<img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/transparent_stat.png" alt="Stats" style="width: 15%;">
</a>
</div>

## 🎓 引用

如果您将我们的库用于研究目的,请引用以下参考文献:
Expand All @@ -199,16 +207,19 @@ print(result)
<p align="center">
<img src="https://raw.githubusercontent.com/VinciGit00/Scrapegraph-ai/main/docs/assets/logo_authors.png" alt="Authors_logos">
</p>

## 联系方式
| | Contact Info |
|--------------------|----------------------|
| Marco Vinciguerra | [![Linkedin Badge](https://img.shields.io/badge/-Linkedin-blue?style=flat&logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/marco-vinciguerra-7ba365242/) |
| Marco Perini | [![Linkedin Badge](https://img.shields.io/badge/-Linkedin-blue?style=flat&logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/perinim/) |
| Lorenzo Padoan | [![Linkedin Badge](https://img.shields.io/badge/-Linkedin-blue?style=flat&logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/lorenzo-padoan-4521a2154/) |

Marco Vinciguerra
Marco Perini
Lorenzo Padoan
## 📜 许可证

ScrapeGraphAI 采用 MIT 许可证。更多信息请查看 LICENSE 文件。
ScrapeGraphAI 采用 MIT 许可证。更多信息请查看 [LICENSE](https://github.com/VinciGit00/Scrapegraph-ai/blob/main/LICENSE) 文件。

鸣谢
## 鸣谢

我们要感谢所有项目贡献者和开源社区的支持。
ScrapeGraphAI 仅用于数据探索和研究目的。我们不对任何滥用该库的行为负责。
- 我们要感谢所有项目贡献者和开源社区的支持。
- ScrapeGraphAI 仅用于数据探索和研究目的。我们不对任何滥用该库的行为负责。