PlotAI 使用教程

马琥承

于 2024-08-31 10:01:41 发布

阅读量719

点赞数 18

本文链接：https://blog.csdn.net/gitblog_00306/article/details/141747589

版权

PlotAI 使用教程

plotaiPlotAI - Your Ultimate Plotting Assistant! 📊🤖 Use ChatGPT-3.5 to create plots in Python and Matplotlib directly in your Python script or notebook. 项目地址:https://gitcode.com/gh_mirrors/pl/plotai

1. 项目目录结构及介绍

PlotAI 是一个基于Python的库，旨在通过使用OpenAI的ChatGPT-3.5-turbo模型来简化matplotlib图形的创建过程。以下是该仓库的基本目录结构及其简介：

.
├── env                    # 环境模板文件夹，包含虚拟环境配置
├── gitignore              # Git忽略文件，定义了哪些文件不应被版本控制
├── LICENSE                # 许可证文件，采用Apache-2.0许可协议
├── MANIFEST.in            # 规定了哪些额外文件应包含在源代码包中
├── README.md              # 项目的主要读我文件，介绍了项目功能和如何开始使用
├── requirements-dev.txt   # 开发所需的依赖项列表
├── requirements.txt       # 应用运行所需的依赖项列表
├── setup.py               # 包安装脚本，用于pip安装项目
├── tests                  # 测试目录，存放项目的测试代码
└── plotai                 # 主要的项目代码目录，包含核心功能实现

2. 项目启动文件介绍

PlotAI的核心在于其Python接口，没有特定的“启动文件”，但用户可以通过安装plotai包并导入PlotAI类来启动使用。一般而言，用户的“启动”操作是从导入PlotAI类并在他们的Python脚本或Jupyter Notebook中初始化对象开始的。例如，简单的使用示例是导入DataFrame和PlotAI类，然后使用make()方法创建图表。

import pandas as pd
from plotai import PlotAI

df = pd.DataFrame({"x":[1, 2, 3], "y": [4, 5, 6]})
plot = PlotAI(df)
plot.make("scatter plot")

3. 项目的配置文件介绍

PlotAI项目本身没有直接提供的配置文件。然而，为了使用PlotAI，你需要设置环境变量OPENAI_API_KEY来提供你的OpenAI API密钥。这通常不在仓库内以文件形式存在，而是应该由用户在其开发环境中手动设置，或者在.env文件（未直接包含在项目中）中定义，然后在使用前加载该环境变量。

建议的配置方式是在你的项目目录下创建一个.env文件，并添加以下内容：