Kaggle提供一個Public API(即應(yīng)用程序編程接口),可以用來更便捷的創(chuàng)建數(shù)據(jù)集、Notebooks,以及連接上Kaggle。與Kaggle的公共API進行交互的最簡單方法是通過以Python實現(xiàn)的命令行工具(CLI)
首先在終端運行安裝命令:
pip install kaggle
安裝完成之后,默認位置為~/.local/bin,在.bashrc中添加:
export PATH="/home/user1/.local/bin:$PATH"
為了使用API,首先必須創(chuàng)建New API Token,在個人Account中點擊下載,如果使用CLI工具,需要將token移入 ~/.kaggle/kaggle.json 路徑

從Kaggle下載的kaggle.json文件中只包含了username字段和key字段。
path字段即Kaggle下載數(shù)據(jù)集的目錄。
如果不設(shè)置path字段,Kaggle默認的下載目錄是用戶主目錄即$HOME。
可以將path字段設(shè)置為自己想要Kaggle集中下載數(shù)據(jù)到的位置,如:
{
"username": "your_username",
"key": "your_api_key",
"path": "/home/xxx/.kaggle"
}
這樣,數(shù)據(jù)就會下載到用戶主目錄下的 .kaggle 目錄中。
啟動終端運行,查看Kaggle API版本與幫助

常用的基本處理命令
1、處理數(shù)據(jù)集
* 列出與搜索字詞匹配的數(shù)據(jù)集
kaggle datasets list -s [KEYWORD]
* 下載與數(shù)據(jù)集關(guān)聯(lián)的文件
kaggle datasets download -d [DATASET]
創(chuàng)建一個包含要上傳文件的文件夾
kaggle datasets init -p /path/to/dataset
將數(shù)據(jù)集的元數(shù)據(jù)添加到生成的文件中,dataset-metadata.json (或者datapackage.json) 快速創(chuàng)建可以參考(https://create.frictionlessdata.io/)
kaggle datasets create -p /path/to/dataset
創(chuàng)建一個新數(shù)據(jù)集版本
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上創(chuàng)建并運行notebook
kaggle kernels pull [KERNEL] -p /path/to/download -m 下載與notebook關(guān)聯(lián)的代碼文件和元數(shù)據(jù)
創(chuàng)建與運行新Notebook
- 創(chuàng)建一個本地文件夾,其中包含要上傳的代碼文件(例如,Python或R筆記本,腳本或RMarkdown文件)
- 運行命令生成 kernel-metadata.json
kaggle kernels init -p /path/to/kernel
- 將您notebook的元數(shù)據(jù)添加到生成的文件中, kernel-metadata.json; 添加標題和子標題時,請注意,notebook標題和子標題相互鏈接。 notebook子標題始終是標題的小寫字母,用短劃線(-)代替空格并刪除特殊字符。
- 運行命令創(chuàng)建和運行notebook
kaggle kernels push -p /path/to/kernel
如果您要創(chuàng)建和運行現(xiàn)有Notebook的新版本
- 運行命令下載您Notebook的最新代碼和 元數(shù)據(jù) 文件(如果您的本地副本不是最新的)
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工程的輸出結(jié)果
kaggle kernels output [kernel]
([kernel] format <owner>/<kernel-name>)
查看最近運行的notebook工程的狀態(tài)
kaggle kernels status [kernel]
下載.ipynb文件到指定的目錄(~/.kaggle/kernels/<owner>/<kernel-name>目錄下)
kaggle kernels pull [KERNEL] (加上 -m 表示同時下載元數(shù)據(jù))
元數(shù)據(jù)文件 kernel-metadata.json 內(nèi)包含dataset_sources和kernel_sources的設(shè)置
