Kaggle提供一个Public API(即应用程序编程接口),可以用来更便捷的创建数据集、Notebooks,以及连接上Kaggle。与Kaggle的公共API进行交互的最简单方法是通过以Python实现的命令行工具(CLI)
首先在终端运行安装命令:
pip install kaggle
安装完成之后,默认位置为~/.local/bin,在.bashrc中添加:
export PATH="/home/user1/.local/bin:$PATH"
为了使用API,首先必须创建New API Token,在个人Account中点击下载,如果使用CLI工具,需要将token移入 ~/.kaggle/kaggle.json 路径
从Kaggle下载的kaggle.json文件中只包含了username字段和key字段。
path字段即Kaggle下载数据集的目录。
如果不设置path字段,Kaggle默认的下载目录是用户主目录即$HOME。
可以将path字段设置为自己想要Kaggle集中下载数据到的位置,如:
{
"username": "your_username",
"key": "your_api_key",
"path": "/home/xxx/.kaggle"
}
这样,数据就会下载到用户主目录下的 .kaggle 目录中。
启动终端运行,查看Kaggle API版本与帮助
常用的基本处理命令
1、处理数据集
* 列出与搜索字词匹配的数据集
kaggle datasets list -s [KEYWORD]
* 下载与数据集关联的文件
kaggle datasets download -d [DATASET]
创建一个包含要上传文件的文件夹
kaggle datasets init -p /path/to/dataset
将数据集的元数据添加到生成的文件中,dataset-metadata.json (或者datapackage.json) 快速创建可以参考(https://create.frictionlessdata.io/)
kaggle datasets create -p /path/to/dataset
创建一个新数据集版本
kaggle datasets init -p /path/to/dataset
kaggle datasets version -p /path/to/dataset -m "Your message here"
2、处理Notebook
kaggle kernels list -s [KEYWORD] 列出与搜索词匹配的notebook
kaggle kernels push [KERNEL] -p /path/to/kernel 在Kaggle上创建并运行notebook
kaggle kernels pull [KERNEL] -p /path/to/download -m 下载与notebook关联的代码文件和元数据
创建与运行新Notebook
- 创建一个本地文件夹,其中包含要上传的代码文件(例如,Python或R笔记本,脚本或RMarkdown文件)
- 运行命令生成 kernel-metadata.json
kaggle kernels init -p /path/to/kernel
- 将您notebook的元数据添加到生成的文件中, kernel-metadata.json; 添加标题和子标题时,请注意,notebook标题和子标题相互链接。 notebook子标题始终是标题的小写字母,用短划线(-)代替空格并删除特殊字符。
- 运行命令创建和运行notebook
kaggle kernels push -p /path/to/kernel
如果您要创建和运行现有Notebook的新版本
- 运行命令下载您Notebook的最新代码和 元数据 文件(如果您的本地副本不是最新的)
kaggle kernels pull [KERNEL] -p /path/to/download -m
- 确保 kernel-metadata.json文件的 id 域指向您的Notebook; 您不再需要包含 title 字段,对于Notebook版本是可选的,除非您想重命名Notebook(请确保更新 id 重命名完成后,在下一次推送中输入字段)
- 运行命令
kaggle kernels push -p /path/to/kernel
实用命令
列出本人目录下notebook工程
kaggle kernels list -m
下载最近运行的notebook工程的输出结果
kaggle kernels output [kernel]
([kernel] format <owner>/<kernel-name>)
查看最近运行的notebook工程的状态
kaggle kernels status [kernel]
下载.ipynb文件到指定的目录(~/.kaggle/kernels/<owner>/<kernel-name>目录下)
kaggle kernels pull [KERNEL] (加上 -m 表示同时下载元数据)
元数据文件 kernel-metadata.json 内包含dataset_sources和kernel_sources的设置