From 2bfbc53f54f9ce6325ced7611cbb54b8eff721f9 Mon Sep 17 00:00:00 2001 From: eagle666 <2627343898@qq.com> Date: Wed, 19 Mar 2025 10:39:44 +0800 Subject: [PATCH 1/2] docs:Add Chinese, French, Japanese version of README --- README.md | 7 ++ docs/README_CN.md | 227 ++++++++++++++++++++++++++++++++++++++++++++++ docs/README_FR.md | 227 ++++++++++++++++++++++++++++++++++++++++++++++ docs/README_JA.md | 227 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 688 insertions(+) create mode 100644 docs/README_CN.md create mode 100644 docs/README_FR.md create mode 100644 docs/README_JA.md diff --git a/README.md b/README.md index 92739b4e0..2f9b2ea29 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ #  +
+ [](https://pypi.org/project/pandasai/) [](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/ci-core.yml/badge.svg) [](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/cd.yml/badge.svg) diff --git a/docs/README_CN.md b/docs/README_CN.md new file mode 100644 index 000000000..a8c928d78 --- /dev/null +++ b/docs/README_CN.md @@ -0,0 +1,227 @@ +#  + + + +[](https://pypi.org/project/pandasai/) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/ci-core.yml/badge.svg) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/cd.yml/badge.svg) +[](https://codecov.io/gh/sinaptik-ai/pandas-ai) +[](https://discord.gg/KYKj9F2FRH) +[](https://pepy.tech/project/pandasai) [](https://opensource.org/licenses/MIT) +[](https://colab.research.google.com/drive/1ZnO-njhL7TBOYPZaqvMvGtsjckZKrv2E?usp=sharing) + +PandaAI 是一个 Python 平台,可以轻松地用自然语言向您的数据提问。它帮助非技术用户以更自然的方式与数据交互,并帮助技术用户在处理数据时节省时间和精力。 + +# 🔧 入门指南 + +您可以在此处找到 PandaAI 的完整文档 [here](https://pandas-ai.readthedocs.io/en/latest/)。 + +您可以选择在 Jupyter 笔记本、Streamlit 应用中使用 PandaAI,或者从仓库中使用客户端和服务器架构。 + +## ☁️ 使用平台 + +该库可以与我们的强大数据平台一起使用,只需几行代码即可实现端到端的对话式数据分析。 + +加载您的数据,将其保存为数据框,并将其推送到平台 + +```python +import pandasai as pai + +pai.api_key.set("your-pai-api-key") + +file = pai.read_csv("./filepath.csv") + +dataset = pai.create(path="your-organization/dataset-name", + df=file, + name="dataset-name", + description="dataset-description") + +dataset.push() +``` + +您的团队现在可以通过平台使用自然语言访问和查询这些数据。 + + + +## 📚 使用库 + +### Python 要求 + +Python 版本 `3.8+ <3.12` + +### 📦 安装 + +您可以使用 pip 或 poetry 安装 PandaAI 库。 + +使用 pip: + +```bash +pip install "pandasai>=3.0.0b2" +``` + +使用 poetry: + +```bash +poetry add "pandasai>=3.0.0b2" +``` + +### 💻 使用 + +#### 提问 + +```python +import pandasai as pai + +# 示例数据框 +df = pai.DataFrame({ + "country": ["United States", "United Kingdom", "France", "Germany", "Italy", "Spain", "Canada", "Australia", "Japan", "China"], + "revenue": [5000, 3200, 2900, 4100, 2300, 2100, 2500, 2600, 4500, 7000] +}) + +# 默认情况下,除非您选择其他 LLM,否则它将使用 BambooLLM。 +# 您可以在 https://app.pandabi.ai 注册获取免费的 API 密钥(也可以在 .env 文件中配置) +pai.api_key.set("your-pai-api-key") + +df.chat('销售额前五的国家是哪些?') +``` + +``` +中国, 美国, 日本, 德国, 澳大利亚 +``` + +--- + +或者您可以提出更复杂的问题: + +```python +df.chat( + "销售额前三的国家的总销售额是多少?" +) +``` + +``` +销售额前三的国家的总销售额为 16500。 +``` + +#### 可视化图表 + +您还可以要求 PandaAI 为您生成图表: + +```python +df.chat( + "绘制各国的直方图,显示每个国家的 GDP,并为每个条形使用不同的颜色", +) +``` + + + +#### 多个数据框 + +您还可以将多个数据框传递给 PandaAI,并提出与之相关的问题。 + +```python +import pandasai as pai + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['HR', 'Sales', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# 默认情况下,除非您选择其他 LLM,否则它将使用 BambooLLM。 +# 您可以在 https://app.pandabi.ai 注册获取免费的 API 密钥(也可以在 .env 文件中配置) +pai.api_key.set("your-pai-api-key") + +pai.chat("谁的收入最高?", employees_df, salaries_df) +``` + +``` +Olivia 的收入最高。 +``` + +#### Docker 沙盒 + +您可以在 Docker 沙盒中运行 PandaAI,提供一个安全、隔离的环境来安全地执行代码,并降低恶意攻击的风险。 + +##### Python 要求 + +```bash +pip install "pandasai-docker" +``` + +##### 使用 + +```python +import pandasai as pai +from pandasai_docker import DockerSandbox + +# 初始化沙盒 +sandbox = DockerSandbox() +sandbox.start() + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['HR', 'Sales', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# 默认情况下,除非您选择其他 LLM,否则它将使用 BambooLLM。 +# 您可以在 https://app.pandabi.ai 注册获取免费的 API 密钥(也可以在 .env 文件中配置) +pai.api_key.set("your-pai-api-key") + +pai.chat("谁的收入最高?", employees_df, salaries_df, sandbox=sandbox) + +# 完成后别忘了停止沙盒 +sandbox.stop() +``` + +``` +Olivia 的收入最高。 +``` + +您可以在 [examples](examples) 目录中找到更多示例。 + +## 📜 许可证 + +PandaAI 在 MIT expat 许可证下可用,除了此仓库的 `pandasai/ee` 目录,该目录有其 [许可证](https://github.com/sinaptik-ai/pandas-ai/blob/main/ee/LICENSE)。 + +如果您对托管 PandaAI 云或自托管企业版感兴趣,请 [联系我们](https://getpanda.ai/pricing)。 + +## 资源 + +> **Beta 通知** +> 版本 v3 目前处于测试阶段。以下文档和示例反映了正在开发中的功能和特性,可能在最终发布前发生变化。 + +- [文档](https://pandas-ai.readthedocs.io/en/latest/) 提供全面的文档 +- [示例](examples) 提供示例笔记本 +- [Discord](https://discord.gg/KYKj9F2FRH) 用于与社区和 PandaAI 团队讨论 + +## 🤝 贡献 + +欢迎贡献!请查看未解决的问题,并随时提交拉取请求。 +有关更多信息,请查看 [贡献指南](CONTRIBUTING.md)。 + +### 感谢! + +[](https://github.com/sinaptik-ai/pandas-ai/graphs/contributors) \ No newline at end of file diff --git a/docs/README_FR.md b/docs/README_FR.md new file mode 100644 index 000000000..27441e3e6 --- /dev/null +++ b/docs/README_FR.md @@ -0,0 +1,227 @@ +#  + + + +[](https://pypi.org/project/pandasai/) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/ci-core.yml/badge.svg) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/cd.yml/badge.svg) +[](https://codecov.io/gh/sinaptik-ai/pandas-ai) +[](https://discord.gg/KYKj9F2FRH) +[](https://pepy.tech/project/pandasai) [](https://opensource.org/licenses/MIT) +[](https://colab.research.google.com/drive/1ZnO-njhL7TBOYPZaqvMvGtsjckZKrv2E?usp=sharing) + +PandaAI est une plateforme Python qui permet de poser des questions à vos données en langage naturel. Elle aide les utilisateurs non techniques à interagir avec leurs données de manière plus naturelle, et elle aide les utilisateurs techniques à gagner du temps et des efforts lorsqu'ils travaillent avec des données. + +# 🔧 Premiers pas + +Vous pouvez trouver la documentation complète de PandaAI [ici](https://pandas-ai.readthedocs.io/en/latest/). + +Vous pouvez choisir d'utiliser PandaAI dans vos notebooks Jupyter, vos applications Streamlit, ou utiliser l'architecture client-serveur du dépôt. + +## ☁️ Utilisation de la plateforme + +La bibliothèque peut être utilisée avec notre puissante plateforme de données, permettant une analyse de données conversationnelle de bout en bout avec seulement quelques lignes de code. + +Chargez vos données, enregistrez-les sous forme de dataframe, et poussez-les vers la plateforme + +```python +import pandasai as pai + +pai.api_key.set("votre-clé-api-pai") + +file = pai.read_csv("./chemin/du/fichier.csv") + +dataset = pai.create(path="votre-organisation/nom-du-dataset", + df=file, + name="nom-du-dataset", + description="description-du-dataset") + +dataset.push() +``` + +Votre équipe peut maintenant accéder et interroger ces données en langage naturel via la plateforme. + + + +## 📚 Utilisation de la bibliothèque + +### Prérequis Python + +Version de Python `3.8+ <3.12` + +### 📦 Installation + +Vous pouvez installer la bibliothèque PandaAI en utilisant pip ou poetry. + +Avec pip : + +```bash +pip install "pandasai>=3.0.0b2" +``` + +Avec poetry : + +```bash +poetry add "pandasai>=3.0.0b2" +``` + +### 💻 Utilisation + +#### Poser des questions + +```python +import pandasai as pai + +# Exemple de DataFrame +df = pai.DataFrame({ + "country": ["États-Unis", "Royaume-Uni", "France", "Allemagne", "Italie", "Espagne", "Canada", "Australie", "Japon", "Chine"], + "revenue": [5000, 3200, 2900, 4100, 2300, 2100, 2500, 2600, 4500, 7000] +}) + +# Par défaut, à moins que vous ne choisissiez un autre LLM, il utilisera BambooLLM. +# Vous pouvez obtenir votre clé API gratuite en vous inscrivant sur https://app.pandabi.ai (vous pouvez également la configurer dans votre fichier .env) +pai.api_key.set("votre-clé-api-pai") + +df.chat('Quels sont les 5 premiers pays par ventes ?') +``` + +``` +Chine, États-Unis, Japon, Allemagne, Australie +``` + +--- + +Ou vous pouvez poser des questions plus complexes : + +```python +df.chat( + "Quel est le total des ventes pour les 3 premiers pays par ventes ?" +) +``` + +``` +Le total des ventes pour les 3 premiers pays par ventes est de 16500. +``` + +#### Visualiser des graphiques + +Vous pouvez également demander à PandaAI de générer des graphiques pour vous : + +```python +df.chat( + "Tracez l'histogramme des pays en montrant pour chacun le PIB. Utilisez des couleurs différentes pour chaque barre", +) +``` + + + +#### Plusieurs DataFrames + +Vous pouvez également passer plusieurs dataframes à PandaAI et poser des questions les reliant. + +```python +import pandasai as pai + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['RH', 'Ventes', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# Par défaut, à moins que vous ne choisissiez un autre LLM, il utilisera BambooLLM. +# Vous pouvez obtenir votre clé API gratuite en vous inscrivant sur https://app.pandabi.ai (vous pouvez également la configurer dans votre fichier .env) +pai.api_key.set("votre-clé-api-pai") + +pai.chat("Qui est le mieux payé ?", employees_df, salaries_df) +``` + +``` +Olivia est la mieux payée. +``` + +#### Sandbox Docker + +Vous pouvez exécuter PandaAI dans un sandbox Docker, fournissant un environnement sécurisé et isolé pour exécuter du code en toute sécurité et atténuer le risque d'attaques malveillantes. + +##### Prérequis Python + +```bash +pip install "pandasai-docker" +``` + +##### Utilisation + +```python +import pandasai as pai +from pandasai_docker import DockerSandbox + +# Initialiser le sandbox +sandbox = DockerSandbox() +sandbox.start() + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['RH', 'Ventes', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# Par défaut, à moins que vous ne choisissiez un autre LLM, il utilisera BambooLLM. +# Vous pouvez obtenir votre clé API gratuite en vous inscrivant sur https://app.pandabi.ai (vous pouvez également la configurer dans votre fichier .env) +pai.api_key.set("votre-clé-api-pai") + +pai.chat("Qui est le mieux payé ?", employees_df, salaries_df, sandbox=sandbox) + +# N'oubliez pas d'arrêter le sandbox une fois terminé +sandbox.stop() +``` + +``` +Olivia est la mieux payée. +``` + +Vous pouvez trouver plus d'exemples dans le répertoire [examples](examples). + +## 📜 Licence + +PandaAI est disponible sous la licence MIT expat, à l'exception du répertoire `pandasai/ee` de ce dépôt, qui a sa [licence ici](https://github.com/sinaptik-ai/pandas-ai/blob/main/ee/LICENSE). + +Si vous êtes intéressé par PandaAI Cloud géré ou l'offre Enterprise auto-hébergée, [contactez-nous](https://getpanda.ai/pricing). + +## Ressources + +> **Avis Beta** +> La version v3 est actuellement en version bêta. La documentation et les exemples suivants reflètent les fonctionnalités en cours de développement et peuvent changer avant la version finale. + +- [Docs](https://pandas-ai.readthedocs.io/en/latest/) pour la documentation complète +- [Exemples](examples) pour les notebooks d'exemples +- [Discord](https://discord.gg/KYKj9F2FRH) pour discuter avec la communauté et l'équipe PandaAI + +## 🤝 Contributions + +Les contributions sont les bienvenues ! Veuillez consulter les problèmes en suspens et n'hésitez pas à ouvrir une pull request. +Pour plus d'informations, veuillez consulter les [lignes directrices de contribution](CONTRIBUTING.md). + +### Merci ! + +[](https://github.com/sinaptik-ai/pandas-ai/graphs/contributors) \ No newline at end of file diff --git a/docs/README_JA.md b/docs/README_JA.md new file mode 100644 index 000000000..de8df3b4d --- /dev/null +++ b/docs/README_JA.md @@ -0,0 +1,227 @@ +#  + + + +[](https://pypi.org/project/pandasai/) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/ci-core.yml/badge.svg) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/cd.yml/badge.svg) +[](https://codecov.io/gh/sinaptik-ai/pandas-ai) +[](https://discord.gg/KYKj9F2FRH) +[](https://pepy.tech/project/pandasai) [](https://opensource.org/licenses/MIT) +[](https://colab.research.google.com/drive/1ZnO-njhL7TBOYPZaqvMvGtsjckZKrv2E?usp=sharing) + +PandaAIは、自然言語でデータに質問することを容易にするPythonプラットフォームです。非技術ユーザーがデータとより自然な方法で対話するのを助け、技術ユーザーがデータを扱う際の時間と労力を節約するのに役立ちます。 + +# 🔧 はじめに + +PandaAIの完全なドキュメントは[こちら](https://pandas-ai.readthedocs.io/en/latest/)で見つけることができます。 + +JupyterノートブックやStreamlitアプリでPandaAIを使用するか、リポジトリからクライアントとサーバーのアーキテクチャを使用することができます。 + +## ☁️ プラットフォームの使用 + +このライブラリは、強力なデータプラットフォームと併用することができ、わずか数行のコードでエンドツーエンドの会話型データ分析を可能にします。 + +データを読み込み、データフレームとして保存し、プラットフォームにプッシュします。 + +```python +import pandasai as pai + +pai.api_key.set("your-pai-api-key") + +file = pai.read_csv("./filepath.csv") + +dataset = pai.create(path="your-organization/dataset-name", + df=file, + name="dataset-name", + description="dataset-description") + +dataset.push() +``` + +これで、チームはプラットフォームを通じて自然言語でこのデータにアクセスし、クエリを実行できます。 + + + +## 📚 ライブラリの使用 + +### Pythonの要件 + +Pythonバージョン `3.8+ <3.12` + +### 📦 インストール + +PandaAIライブラリはpipまたはpoetryを使用してインストールできます。 + +pipを使用する場合: + +```bash +pip install "pandasai>=3.0.0b2" +``` + +poetryを使用する場合: + +```bash +poetry add "pandasai>=3.0.0b2" +``` + +### 💻 使用法 + +#### 質問する + +```python +import pandasai as pai + +# サンプルデータフレーム +df = pai.DataFrame({ + "country": ["United States", "United Kingdom", "France", "Germany", "Italy", "Spain", "Canada", "Australia", "Japan", "China"], + "revenue": [5000, 3200, 2900, 4100, 2300, 2100, 2500, 2600, 4500, 7000] +}) + +# デフォルトでは、別のLLMを選択しない限り、BambooLLMを使用します。 +# https://app.pandabi.ai でサインアップして無料のAPIキーを取得できます(.envファイルで設定することもできます)。 +pai.api_key.set("your-pai-api-key") + +df.chat('売上上位5か国はどれですか?') +``` + +``` +中国、アメリカ、日本、ドイツ、オーストラリア +``` + +--- + +または、より複雑な質問をすることもできます: + +```python +df.chat( + "売上上位3か国の総売上はいくらですか?" +) +``` + +``` +売上上位3か国の総売上は16500です。 +``` + +#### チャートの可視化 + +PandaAIにチャートを生成させることもできます: + +```python +df.chat( + "各国のGDPを示すヒストグラムをプロットしてください。各バーに異なる色を使用してください", +) +``` + + + +#### 複数のデータフレーム + +複数のデータフレームをPandaAIに渡し、それらに関連する質問をすることもできます。 + +```python +import pandasai as pai + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['HR', 'Sales', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# デフォルトでは、別のLLMを選択しない限り、BambooLLMを使用します。 +# https://app.pandabi.ai でサインアップして無料のAPIキーを取得できます(.envファイルで設定することもできます)。 +pai.api_key.set("your-pai-api-key") + +pai.chat("誰が最も多く給与をもらっていますか?", employees_df, salaries_df) +``` + +``` +Oliviaが最も多く給与をもらっています。 +``` + +#### Dockerサンドボックス + +PandaAIをDockerサンドボックスで実行し、安全で隔離された環境でコードを実行し、悪意のある攻撃のリスクを軽減することができます。 + +##### Pythonの要件 + +```bash +pip install "pandasai-docker" +``` + +##### 使用法 + +```python +import pandasai as pai +from pandasai_docker import DockerSandbox + +# サンドボックスの初期化 +sandbox = DockerSandbox() +sandbox.start() + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['HR', 'Sales', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# デフォルトでは、別のLLMを選択しない限り、BambooLLMを使用します。 +# https://app.pandabi.ai でサインアップして無料のAPIキーを取得できます(.envファイルで設定することもできます)。 +pai.api_key.set("your-pai-api-key") + +pai.chat("誰が最も多く給与をもらっていますか?", employees_df, salaries_df, sandbox=sandbox) + +# 終了時にサンドボックスを停止することを忘れないでください +sandbox.stop() +``` + +``` +Oliviaが最も多く給与をもらっています。 +``` + +その他の例は[examples](examples)ディレクトリで見つけることができます。 + +## 📜 ライセンス + +PandaAIはMIT expatライセンスの下で利用可能ですが、このリポジトリの`pandasai/ee`ディレクトリは[こちら](https://github.com/sinaptik-ai/pandas-ai/blob/main/ee/LICENSE)に独自のライセンスがあります。 + +管理されたPandaAI Cloudまたはセルフホスト型のエンタープライズオファリングに興味がある場合は、[お問い合わせください](https://getpanda.ai/pricing)。 + +## リソース + +> **ベータ版のお知らせ** +> リリースv3は現在ベータ版です。以下のドキュメントと例は、進行中の機能と機能を反映しており、最終リリース前に変更される可能性があります。 + +- [ドキュメント](https://pandas-ai.readthedocs.io/en/latest/) 包括的なドキュメント +- [例](examples) サンプルノートブック +- [Discord](https://discord.gg/KYKj9F2FRH) コミュニティとPandaAIチームとのディスカッション + +## 🤝 貢献 + +貢献は大歓迎です!未解決のイシューを確認し、プルリクエストを自由に開いてください。 +詳細については、[貢献ガイドライン](CONTRIBUTING.md)を確認してください。 + +### ありがとうございます! + +[](https://github.com/sinaptik-ai/pandas-ai/graphs/contributors) \ No newline at end of file From a740d60b2cb7f13f4c00fb3b15279cd8003e072c Mon Sep 17 00:00:00 2001 From: eagle666 <2627343898@qq.com> Date: Wed, 19 Mar 2025 10:39:44 +0800 Subject: [PATCH 2/2] docs:Add Chinese, French, Japanese version of README --- README.md | 7 ++ docs/README_CN.md | 227 ++++++++++++++++++++++++++++++++++++++++++++++ docs/README_FR.md | 227 ++++++++++++++++++++++++++++++++++++++++++++++ docs/README_JA.md | 227 ++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 688 insertions(+) create mode 100644 docs/README_CN.md create mode 100644 docs/README_FR.md create mode 100644 docs/README_JA.md diff --git a/README.md b/README.md index 92739b4e0..2f9b2ea29 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ #  + + [](https://pypi.org/project/pandasai/) [](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/ci-core.yml/badge.svg) [](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/cd.yml/badge.svg) diff --git a/docs/README_CN.md b/docs/README_CN.md new file mode 100644 index 000000000..a8c928d78 --- /dev/null +++ b/docs/README_CN.md @@ -0,0 +1,227 @@ +#  + + + +[](https://pypi.org/project/pandasai/) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/ci-core.yml/badge.svg) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/cd.yml/badge.svg) +[](https://codecov.io/gh/sinaptik-ai/pandas-ai) +[](https://discord.gg/KYKj9F2FRH) +[](https://pepy.tech/project/pandasai) [](https://opensource.org/licenses/MIT) +[](https://colab.research.google.com/drive/1ZnO-njhL7TBOYPZaqvMvGtsjckZKrv2E?usp=sharing) + +PandaAI 是一个 Python 平台,可以轻松地用自然语言向您的数据提问。它帮助非技术用户以更自然的方式与数据交互,并帮助技术用户在处理数据时节省时间和精力。 + +# 🔧 入门指南 + +您可以在此处找到 PandaAI 的完整文档 [here](https://pandas-ai.readthedocs.io/en/latest/)。 + +您可以选择在 Jupyter 笔记本、Streamlit 应用中使用 PandaAI,或者从仓库中使用客户端和服务器架构。 + +## ☁️ 使用平台 + +该库可以与我们的强大数据平台一起使用,只需几行代码即可实现端到端的对话式数据分析。 + +加载您的数据,将其保存为数据框,并将其推送到平台 + +```python +import pandasai as pai + +pai.api_key.set("your-pai-api-key") + +file = pai.read_csv("./filepath.csv") + +dataset = pai.create(path="your-organization/dataset-name", + df=file, + name="dataset-name", + description="dataset-description") + +dataset.push() +``` + +您的团队现在可以通过平台使用自然语言访问和查询这些数据。 + + + +## 📚 使用库 + +### Python 要求 + +Python 版本 `3.8+ <3.12` + +### 📦 安装 + +您可以使用 pip 或 poetry 安装 PandaAI 库。 + +使用 pip: + +```bash +pip install "pandasai>=3.0.0b2" +``` + +使用 poetry: + +```bash +poetry add "pandasai>=3.0.0b2" +``` + +### 💻 使用 + +#### 提问 + +```python +import pandasai as pai + +# 示例数据框 +df = pai.DataFrame({ + "country": ["United States", "United Kingdom", "France", "Germany", "Italy", "Spain", "Canada", "Australia", "Japan", "China"], + "revenue": [5000, 3200, 2900, 4100, 2300, 2100, 2500, 2600, 4500, 7000] +}) + +# 默认情况下,除非您选择其他 LLM,否则它将使用 BambooLLM。 +# 您可以在 https://app.pandabi.ai 注册获取免费的 API 密钥(也可以在 .env 文件中配置) +pai.api_key.set("your-pai-api-key") + +df.chat('销售额前五的国家是哪些?') +``` + +``` +中国, 美国, 日本, 德国, 澳大利亚 +``` + +--- + +或者您可以提出更复杂的问题: + +```python +df.chat( + "销售额前三的国家的总销售额是多少?" +) +``` + +``` +销售额前三的国家的总销售额为 16500。 +``` + +#### 可视化图表 + +您还可以要求 PandaAI 为您生成图表: + +```python +df.chat( + "绘制各国的直方图,显示每个国家的 GDP,并为每个条形使用不同的颜色", +) +``` + + + +#### 多个数据框 + +您还可以将多个数据框传递给 PandaAI,并提出与之相关的问题。 + +```python +import pandasai as pai + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['HR', 'Sales', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# 默认情况下,除非您选择其他 LLM,否则它将使用 BambooLLM。 +# 您可以在 https://app.pandabi.ai 注册获取免费的 API 密钥(也可以在 .env 文件中配置) +pai.api_key.set("your-pai-api-key") + +pai.chat("谁的收入最高?", employees_df, salaries_df) +``` + +``` +Olivia 的收入最高。 +``` + +#### Docker 沙盒 + +您可以在 Docker 沙盒中运行 PandaAI,提供一个安全、隔离的环境来安全地执行代码,并降低恶意攻击的风险。 + +##### Python 要求 + +```bash +pip install "pandasai-docker" +``` + +##### 使用 + +```python +import pandasai as pai +from pandasai_docker import DockerSandbox + +# 初始化沙盒 +sandbox = DockerSandbox() +sandbox.start() + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['HR', 'Sales', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# 默认情况下,除非您选择其他 LLM,否则它将使用 BambooLLM。 +# 您可以在 https://app.pandabi.ai 注册获取免费的 API 密钥(也可以在 .env 文件中配置) +pai.api_key.set("your-pai-api-key") + +pai.chat("谁的收入最高?", employees_df, salaries_df, sandbox=sandbox) + +# 完成后别忘了停止沙盒 +sandbox.stop() +``` + +``` +Olivia 的收入最高。 +``` + +您可以在 [examples](examples) 目录中找到更多示例。 + +## 📜 许可证 + +PandaAI 在 MIT expat 许可证下可用,除了此仓库的 `pandasai/ee` 目录,该目录有其 [许可证](https://github.com/sinaptik-ai/pandas-ai/blob/main/ee/LICENSE)。 + +如果您对托管 PandaAI 云或自托管企业版感兴趣,请 [联系我们](https://getpanda.ai/pricing)。 + +## 资源 + +> **Beta 通知** +> 版本 v3 目前处于测试阶段。以下文档和示例反映了正在开发中的功能和特性,可能在最终发布前发生变化。 + +- [文档](https://pandas-ai.readthedocs.io/en/latest/) 提供全面的文档 +- [示例](examples) 提供示例笔记本 +- [Discord](https://discord.gg/KYKj9F2FRH) 用于与社区和 PandaAI 团队讨论 + +## 🤝 贡献 + +欢迎贡献!请查看未解决的问题,并随时提交拉取请求。 +有关更多信息,请查看 [贡献指南](CONTRIBUTING.md)。 + +### 感谢! + +[](https://github.com/sinaptik-ai/pandas-ai/graphs/contributors) \ No newline at end of file diff --git a/docs/README_FR.md b/docs/README_FR.md new file mode 100644 index 000000000..27441e3e6 --- /dev/null +++ b/docs/README_FR.md @@ -0,0 +1,227 @@ +#  + + + +[](https://pypi.org/project/pandasai/) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/ci-core.yml/badge.svg) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/cd.yml/badge.svg) +[](https://codecov.io/gh/sinaptik-ai/pandas-ai) +[](https://discord.gg/KYKj9F2FRH) +[](https://pepy.tech/project/pandasai) [](https://opensource.org/licenses/MIT) +[](https://colab.research.google.com/drive/1ZnO-njhL7TBOYPZaqvMvGtsjckZKrv2E?usp=sharing) + +PandaAI est une plateforme Python qui permet de poser des questions à vos données en langage naturel. Elle aide les utilisateurs non techniques à interagir avec leurs données de manière plus naturelle, et elle aide les utilisateurs techniques à gagner du temps et des efforts lorsqu'ils travaillent avec des données. + +# 🔧 Premiers pas + +Vous pouvez trouver la documentation complète de PandaAI [ici](https://pandas-ai.readthedocs.io/en/latest/). + +Vous pouvez choisir d'utiliser PandaAI dans vos notebooks Jupyter, vos applications Streamlit, ou utiliser l'architecture client-serveur du dépôt. + +## ☁️ Utilisation de la plateforme + +La bibliothèque peut être utilisée avec notre puissante plateforme de données, permettant une analyse de données conversationnelle de bout en bout avec seulement quelques lignes de code. + +Chargez vos données, enregistrez-les sous forme de dataframe, et poussez-les vers la plateforme + +```python +import pandasai as pai + +pai.api_key.set("votre-clé-api-pai") + +file = pai.read_csv("./chemin/du/fichier.csv") + +dataset = pai.create(path="votre-organisation/nom-du-dataset", + df=file, + name="nom-du-dataset", + description="description-du-dataset") + +dataset.push() +``` + +Votre équipe peut maintenant accéder et interroger ces données en langage naturel via la plateforme. + + + +## 📚 Utilisation de la bibliothèque + +### Prérequis Python + +Version de Python `3.8+ <3.12` + +### 📦 Installation + +Vous pouvez installer la bibliothèque PandaAI en utilisant pip ou poetry. + +Avec pip : + +```bash +pip install "pandasai>=3.0.0b2" +``` + +Avec poetry : + +```bash +poetry add "pandasai>=3.0.0b2" +``` + +### 💻 Utilisation + +#### Poser des questions + +```python +import pandasai as pai + +# Exemple de DataFrame +df = pai.DataFrame({ + "country": ["États-Unis", "Royaume-Uni", "France", "Allemagne", "Italie", "Espagne", "Canada", "Australie", "Japon", "Chine"], + "revenue": [5000, 3200, 2900, 4100, 2300, 2100, 2500, 2600, 4500, 7000] +}) + +# Par défaut, à moins que vous ne choisissiez un autre LLM, il utilisera BambooLLM. +# Vous pouvez obtenir votre clé API gratuite en vous inscrivant sur https://app.pandabi.ai (vous pouvez également la configurer dans votre fichier .env) +pai.api_key.set("votre-clé-api-pai") + +df.chat('Quels sont les 5 premiers pays par ventes ?') +``` + +``` +Chine, États-Unis, Japon, Allemagne, Australie +``` + +--- + +Ou vous pouvez poser des questions plus complexes : + +```python +df.chat( + "Quel est le total des ventes pour les 3 premiers pays par ventes ?" +) +``` + +``` +Le total des ventes pour les 3 premiers pays par ventes est de 16500. +``` + +#### Visualiser des graphiques + +Vous pouvez également demander à PandaAI de générer des graphiques pour vous : + +```python +df.chat( + "Tracez l'histogramme des pays en montrant pour chacun le PIB. Utilisez des couleurs différentes pour chaque barre", +) +``` + + + +#### Plusieurs DataFrames + +Vous pouvez également passer plusieurs dataframes à PandaAI et poser des questions les reliant. + +```python +import pandasai as pai + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['RH', 'Ventes', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# Par défaut, à moins que vous ne choisissiez un autre LLM, il utilisera BambooLLM. +# Vous pouvez obtenir votre clé API gratuite en vous inscrivant sur https://app.pandabi.ai (vous pouvez également la configurer dans votre fichier .env) +pai.api_key.set("votre-clé-api-pai") + +pai.chat("Qui est le mieux payé ?", employees_df, salaries_df) +``` + +``` +Olivia est la mieux payée. +``` + +#### Sandbox Docker + +Vous pouvez exécuter PandaAI dans un sandbox Docker, fournissant un environnement sécurisé et isolé pour exécuter du code en toute sécurité et atténuer le risque d'attaques malveillantes. + +##### Prérequis Python + +```bash +pip install "pandasai-docker" +``` + +##### Utilisation + +```python +import pandasai as pai +from pandasai_docker import DockerSandbox + +# Initialiser le sandbox +sandbox = DockerSandbox() +sandbox.start() + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['RH', 'Ventes', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# Par défaut, à moins que vous ne choisissiez un autre LLM, il utilisera BambooLLM. +# Vous pouvez obtenir votre clé API gratuite en vous inscrivant sur https://app.pandabi.ai (vous pouvez également la configurer dans votre fichier .env) +pai.api_key.set("votre-clé-api-pai") + +pai.chat("Qui est le mieux payé ?", employees_df, salaries_df, sandbox=sandbox) + +# N'oubliez pas d'arrêter le sandbox une fois terminé +sandbox.stop() +``` + +``` +Olivia est la mieux payée. +``` + +Vous pouvez trouver plus d'exemples dans le répertoire [examples](examples). + +## 📜 Licence + +PandaAI est disponible sous la licence MIT expat, à l'exception du répertoire `pandasai/ee` de ce dépôt, qui a sa [licence ici](https://github.com/sinaptik-ai/pandas-ai/blob/main/ee/LICENSE). + +Si vous êtes intéressé par PandaAI Cloud géré ou l'offre Enterprise auto-hébergée, [contactez-nous](https://getpanda.ai/pricing). + +## Ressources + +> **Avis Beta** +> La version v3 est actuellement en version bêta. La documentation et les exemples suivants reflètent les fonctionnalités en cours de développement et peuvent changer avant la version finale. + +- [Docs](https://pandas-ai.readthedocs.io/en/latest/) pour la documentation complète +- [Exemples](examples) pour les notebooks d'exemples +- [Discord](https://discord.gg/KYKj9F2FRH) pour discuter avec la communauté et l'équipe PandaAI + +## 🤝 Contributions + +Les contributions sont les bienvenues ! Veuillez consulter les problèmes en suspens et n'hésitez pas à ouvrir une pull request. +Pour plus d'informations, veuillez consulter les [lignes directrices de contribution](CONTRIBUTING.md). + +### Merci ! + +[](https://github.com/sinaptik-ai/pandas-ai/graphs/contributors) \ No newline at end of file diff --git a/docs/README_JA.md b/docs/README_JA.md new file mode 100644 index 000000000..a70bdf4a6 --- /dev/null +++ b/docs/README_JA.md @@ -0,0 +1,227 @@ +#  + + + +[](https://pypi.org/project/pandasai/) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/ci-core.yml/badge.svg) +[](https://github.com/sinaptik-ai/pandas-ai/actions/workflows/cd.yml/badge.svg) +[](https://codecov.io/gh/sinaptik-ai/pandas-ai) +[](https://discord.gg/KYKj9F2FRH) +[](https://pepy.tech/project/pandasai) [](https://opensource.org/licenses/MIT) +[](https://colab.research.google.com/drive/1ZnO-njhL7TBOYPZaqvMvGtsjckZKrv2E?usp=sharing) + +PandaAIは、自然言語でデータに質問することを容易にするPythonプラットフォームです。非技術ユーザーがデータとより自然な方法で対話するのを助け、技術ユーザーがデータを扱う際の時間と労力を節約するのに役立ちます。 + +# 🔧 はじめに + +PandaAIの完全なドキュメントは[こちら](https://pandas-ai.readthedocs.io/en/latest/)で見つけることができます。 + +JupyterノートブックやStreamlitアプリでPandaAIを使用するか、リポジトリからクライアントとサーバーのアーキテクチャを使用することができます。 + +## ☁️ プラットフォームの使用 + +このライブラリは、強力なデータプラットフォームと併用することができ、わずか数行のコードでエンドツーエンドの会話型データ分析を可能にします。 + +データを読み込み、データフレームとして保存し、プラットフォームにプッシュします。 + +```python +import pandasai as pai + +pai.api_key.set("your-pai-api-key") + +file = pai.read_csv("./filepath.csv") + +dataset = pai.create(path="your-organization/dataset-name", + df=file, + name="dataset-name", + description="dataset-description") + +dataset.push() +``` + +これで、チームはプラットフォームを通じて自然言語でこのデータにアクセスし、クエリを実行できます。 + + + +## 📚 ライブラリの使用 + +### Pythonの要件 + +Pythonバージョン `3.8+ <3.12` + +### 📦 インストール + +PandaAIライブラリはpipまたはpoetryを使用してインストールできます。 + +pipを使用する場合: + +```bash +pip install "pandasai>=3.0.0b2" +``` + +poetryを使用する場合: + +```bash +poetry add "pandasai>=3.0.0b2" +``` + +### 💻 使用法 + +#### 質問する + +```python +import pandasai as pai + +# サンプルデータフレーム +df = pai.DataFrame({ + "country": ["United States", "United Kingdom", "France", "Germany", "Italy", "Spain", "Canada", "Australia", "Japan", "China"], + "revenue": [5000, 3200, 2900, 4100, 2300, 2100, 2500, 2600, 4500, 7000] +}) + +# デフォルトでは、別のLLMを選択しない限り、BambooLLMを使用します。 +# https://app.pandabi.ai でサインアップして無料のAPIキーを取得できます(.envファイルで設定することもできます)。 +pai.api_key.set("your-pai-api-key") + +df.chat('売上上位5か国はどれですか?') +``` + +``` +中国、アメリカ、日本、ドイツ、オーストラリア +``` + +--- + +または、より複雑な質問をすることもできます: + +```python +df.chat( + "売上上位3か国の総売上はいくらですか?" +) +``` + +``` +売上上位3か国の総売上は16500です。 +``` + +#### チャートの可視化 + +PandaAIにチャートを生成させることもできます: + +```python +df.chat( + "各国のGDPを示すヒストグラムをプロットしてください。各バーに異なる色を使用してください", +) +``` + + + +#### 複数のデータフレーム + +複数のデータフレームをPandaAIに渡し、それらに関連する質問をすることもできます。 + +```python +import pandasai as pai + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['HR', 'Sales', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# デフォルトでは、別のLLMを選択しない限り、BambooLLMを使用します。 +# https://app.pandabi.ai でサインアップして無料のAPIキーを取得できます(.envファイルで設定することもできます)。 +pai.api_key.set("your-pai-api-key") + +pai.chat("誰が最も多く給与をもらっていますか?", employees_df, salaries_df) +``` + +``` +Oliviaが最も多く給与をもらっています。 +``` + +#### Dockerサンドボックス + +PandaAIをDockerサンドボックスで実行し、安全で隔離された環境でコードを実行し、悪意のある攻撃のリスクを軽減することができます。 + +##### Pythonの要件 + +```bash +pip install "pandasai-docker" +``` + +##### 使用法 + +```python +import pandasai as pai +from pandasai_docker import DockerSandbox + +# サンドボックスの初期化 +sandbox = DockerSandbox() +sandbox.start() + +employees_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Name': ['John', 'Emma', 'Liam', 'Olivia', 'William'], + 'Department': ['HR', 'Sales', 'IT', 'Marketing', 'Finance'] +} + +salaries_data = { + 'EmployeeID': [1, 2, 3, 4, 5], + 'Salary': [5000, 6000, 4500, 7000, 5500] +} + +employees_df = pai.DataFrame(employees_data) +salaries_df = pai.DataFrame(salaries_data) + +# デフォルトでは、別のLLMを選択しない限り、BambooLLMを使用します。 +# https://app.pandabi.ai でサインアップして無料のAPIキーを取得できます(.envファイルで設定することもできます)。 +pai.api_key.set("your-pai-api-key") + +pai.chat("誰が最も多く給与をもらっていますか?", employees_df, salaries_df, sandbox=sandbox) + +# 終了時にサンドボックスを停止することを忘れないでください +sandbox.stop() +``` + +``` +Oliviaが最も多く給与をもらっています。 +``` + +その他の例は[examples](examples)ディレクトリで見つけることができます。 + +## 📜 ライセンス + +PandaAIはMIT expatライセンスの下で利用可能ですが、このリポジトリの`pandasai/ee`ディレクトリは[こちら](https://github.com/sinaptik-ai/pandas-ai/blob/main/ee/LICENSE)に独自のライセンスがあります。 + +管理されたPandaAI Cloudまたはセルフホスト型のエンタープライズオファリングに興味がある場合は、[お問い合わせください](https://getpanda.ai/pricing)。 + +## リソース + +> **ベータ版のお知らせ** +> リリースv3は現在ベータ版です。以下のドキュメントと例は、進行中の機能と機能を反映しており、最終リリース前に変更される可能性があります。 + +- [ドキュメント](https://pandas-ai.readthedocs.io/en/latest/) 包括的なドキュメント +- [例](examples) サンプルノートブック +- [Discord](https://discord.gg/KYKj9F2FRH) コミュニティとPandaAIチームとのディスカッション + +## 🤝 貢献 + +貢献は大歓迎です!未解決のイシューを確認し、プルリクエストを自由に開いてください。 +詳細については、[貢献ガイドライン](CONTRIBUTING.md)を確認してください。 + +### ありがとうございます! + +[](https://github.com/sinaptik-ai/pandas-ai/graphs/contributors) \ No newline at end of file