tut：【快速开始】安装+使用

更新时间：2024-05-28

AI Studio SDK快速开始

Hub SDK
ERNIE SDK

Hub SDK

飞桨AI Studio模型库是用户分享深度学习模型、demo体验和相关范例教程的地方，支持用户轻松地创建和管理自己的模型，可通过界面或开发环境快速方便地上传、下载相关模型文件并进行二次开发。

aistudio_sdk.hub库可帮助您在不离开开发环境的情况下与Hub进行交互。您可以轻松创建和管理您的个人仓库，下载和上传文件，并从Hub获得有用的模型和相关元数据。

安装

首先请先安装aistudio-sdk库：

pip install --upgrade aistudio-sdk

快速使用

1. 创建仓库 create repo

使用create_repo()创建一个空仓库，并使用repo_id参数为其命名，此参数由仓库所有者的 UID 和repo英文名组成(userid/reponame),可在模型详情页或应用空间查看并复制.

repo_id 查看复制示意

from aistudio_sdk.hub import create_repo
os.environ["AISTUDIO_ACCESS_TOKEN"] = ""
# 创建应用仓库
res = create_repo(
    repo_type="app", # 仓库类型，app表示类型为应用仓库
    repo_id="my_repo_name", # 仓库的名称
    app_name="my_app_name", # 应用名称，如果repo_type为app，则必填
    app_sdk="gradio", # 或streamlit 或者 static 三种
    version="4.26.0", #streamlit 或 gradio 版本，必填, gradio版本支持"4.26.0", "4.0.0" streamlit版本支持"1.33.0", "1.30.0"
    desc="my description", # 描述, 可选
    token="", # 见第三部份第三节
)
# 创建模型仓库
res = create_repo(
    repo_type="model", # 仓库类型，model表示类型为模型仓库，如果创建的是模型仓库，可以不填
    repo_id="myrepoid", # 仓库名称
    model_name='mymodelname', # 模型名称，如果repo_type为model，如果不填写，默认值为repo_id。
    desc="my description", # 描述, 可选
    private=False,
    license='Apache License 2.0'
)
print(res)

2. 文件下载 download

from aistudio_sdk.hub import download
os.environ["AISTUDIO_ACCESS_TOKEN"] = ""

res = download(
    repo_id='myname/myrepoid',
    filename='mydir/my file.txt',
    revision='mybranch'
)
print(res)

3. 文件上传 upload

from aistudio_sdk.hub import upload
os.environ["AISTUDIO_ACCESS_TOKEN"] = ""

res = upload(
    repo_id='myname/myrepoid',
    path_or_fileobj='mydir/my file.txt',
    path_in_repo='dir1/dir2/my cloud file.txt'
)
print(res)

4. 检查文件是否存在上传 file_exists

from aistudio_sdk.hub import file_exists
os.environ["AISTUDIO_ACCESS_TOKEN"] = ""

res = file_exists(
    'myname/myrepoid',
    'mydir/my file.txt',
    revision='mybranch'
)
print(res)

更多API 功能即将上线，敬请期待。

注意事项

特别注意不要混用 ~波浪线与 /Users/${your_username} 。已测得在特殊情况下，会报错本地文件已存在，导致进程不成功，不同版本的python，表现情况也不同。尽可能使用绝对路径。
上传普通文件大小限5M。上传大文件（LFS）限5G。

附录

常用参数说明如下：

入参	参数说明	数据类型	是否必填	默认值
repo_type（新增）	仓库类型，"app"或model，app表示类型为应用仓库，model表示模型库仓库	string	true	无
repo_id	仓库名称。该入参兼容带前缀的写法，例如 repo_id="mynewrepo" 与 repo_id="1234/mynewrepo" 的写法都是合法的。前缀的取值与下载接口、上传接口的含义相同，为UID或者组织名。	string	true	无
app_name（新增）	应用名称，必填	string	true	无
app_sdk（新增）	gradio或streamlit 应用类型	string	true	无
version（新增）	streamlit 或 gradio 版本，必填, gradio版本支持"4.26.0", "4.0.0" streamlit版本支持"1.33.0", "1.30.0"	string	true	无
model_name	模型名称，默认值为仓库名称	string	false	${repo_id}
desc	描述	string	false	无
private	公开或者私密：True 私密，False 公开	bool	false	False（公开）
license	license	string	false	Apache License 2.0
token	Git token 访问令牌	string	false	空

ERNIE SDK

ERNIE SDK是文心&飞桨官方提供的Python软件开发工具包。

ERNIE SDK包含两个项目：ERNIE Bot Agent 和 ERNIE Bot。ERNIE Bot Agent 是百度飞桨推出的基于文心大模型编排能力的大模型智能体开发框架，结合了飞桨星河社区的丰富预置平台功能。ERNIE Bot 则为开发者提供便捷接口，轻松调用文心大模型的文本创作、通用对话、语义向量及AI作图等基础功能。使用ERNIE SDK需要优先完成认证鉴权。

ERNIE SDK认证鉴权主要是设置后端和access token，分别通过api_type和access_token参数来指定。

对于 AI Studio 的用户，默认使用aistudio后端（api_type为aistudio），可前往个人中心的访问令牌页面查看个人专属 access token，复制后填入下面代码中即可（替换{access-token-for-aistudio}）,具体鉴权参数设置方式说明如下：

使用环境变量：

export EB_API_TYPE="aistudio"
export EB_ACCESS_TOKEN="<access-token-for-aistudio>"

使用全局变量：

import erniebot

erniebot.api_type = "aistudio"
erniebot.access_token = "<access-token-for-aistudio>"

使用config参数：

import erniebot

response = erniebot.ChatCompletion.create(
    _config_=dict(
        api_type="aistudio",
        access_token="<access-token-for-aistudio>",
    ),
    model="ernie-3.5",
    messages=[{"role": "user", "content": "你好，请介绍下你自己",
    }],
)

请注意：

不同后端的access token获取方式不同，特定后端获取的access token无法用于其他后端的认证鉴权(上述示例为使用aistudio后端的情况)。
Access Token属于个人账户的重要隐私信息，切记随意对外公开。
aistudio后端的Access Token对应每个用户的个人账户，目前每个账户均拥有100万token的免费额度，可以用于ERNIE SDK相关功能的调用。

更多 ERNIE SDK相关教程及应用体验可参见Github README：

访问令牌

API 文档