nixtla

环境要求

• Python 环境（可执行 pip install）
• 已注册并获取 TimeGPT API Key（README 指向 https://nixtla.io/free-trial）
• 如需在 Snowflake 内运行，需具备 Snowflake 环境及相应权限

安装与启动步骤

1. 1安装 nixtla SDK

   在 Python 环境中安装 Nixtla 官方 SDK，README 要求版本不低于 0.7.0。建议在虚拟环境中安装，避免与其他包冲突。

   pip install nixtla>=0.7.0

   复制

2. 2获取 API Key

   访问 README 给出的免费试用链接注册并获取 API Key，后续实例化客户端时作为参数传入，不要外泄。

3. 3导入库并实例化客户端

   在 Python 中导入 pandas 与 NixtlaClient，用你的 API Key 创建客户端对象；密钥请用真实值替换示例。

   import pandas as pd
   from nixtla import NixtlaClient
   
   nixtla_client = NixtlaClient(api_key='YOUR API KEY HERE')

   复制

4. 4加载历史数据

   读取待预测的历史序列数据（CSV）。README 示例使用电力需求数据，你也可以换成自己的时序文件。

   df = pd.read_csv('/your/path/electricity.csv')

   复制

5. 5调用 TimeGPT 预测

   按 README 的第 3 步使用已经创建的 nixtla_client 对 df 发起预测请求；完整调用代码请以官网文档为准。

6. 6Snowflake 内部署（可选）

   如希望不搬移数据、直接在 Snowflake 中做预测与异常检测，可安装 snowflake 扩展并运行部署脚本。

   pip install nixtla[snowflake]
   python -m nixtla.scripts.snowflake_install_nixtla

   复制

关键配置

如何确认成功

客户端实例化不报鉴权错误，且对 df 发起预测后能正常返回预测结果。

常见问题

注意事项

• README 只给出了安装与客户端实例化示例，预测调用的完整参数请以官网文档为准，不要臆测参数名。
• API Key 属于敏感信息，不要硬编码后提交到代码仓库或公开 notebook。
• Snowflake 部署脚本为交互式，会引导你配置外部访问集成、API Key 及目标数据库与 schema。