2021-03-18 kaggle Public API的使用

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的设置

参考(https://www.kaggle.com/docs/api

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容