LinuxCommandLibrary

kaggle

Download and submit Kaggle datasets/competitions

TLDR

View current configuration values

$ kaggle config view
copy

Download a specific file from a competition dataset
$ kaggle competitions download [competition] [[-f|--file]] [filename]
copy

SYNOPSIS

kaggle [command] [options]

PARAMETERS

competitions
    Lists available competitions, downloads competition data, submits predictions, etc.

datasets
    Lists available datasets, downloads datasets, etc.

kernels
    Lists available kernels (Notebooks), creates new kernels, etc.

models
    Lists available models, downloads models, etc.

config
    Manages the Kaggle API configuration, specifically setting the API credentials.

profile
    Displays Kaggle profile information.

quizzes
    Participates in Kaggle quizzes (for learning purposes).

help
    Displays help information for a specific command.

--version
    Displays the version of the Kaggle CLI.

DESCRIPTION

The kaggle command provides a command-line interface to interact with the Kaggle platform. It allows users to download datasets, submit competition results, create and manage Kaggle kernels (now called Notebooks), and access other Kaggle functionalities directly from their terminal. This tool is particularly useful for scripting and automating data science workflows, facilitating reproducibility, and integrating Kaggle resources into existing development environments. Users can manage their Kaggle API credentials through this interface, enabling secure and efficient access to Kaggle's services. The kaggle command is primarily written in Python and leverages the Kaggle API for its functionality. Through this, users can handle a large variety of operations on the command line without using web interface.

The command is essential for participants in Kaggle competitions and data scientists using Kaggle's resources. It simplifies tasks such as downloading large datasets, managing submissions, and interacting with Kaggle notebooks.

CAVEATS

The kaggle command requires a Kaggle API key to be configured. API keys can be generated from the user's Kaggle account page. The command depends on a stable internet connection to interact with the Kaggle API.

SUBCOMMAND EXAMPLES

kaggle competitions download -c : Downloads data for a specific competition.
kaggle datasets download -d : Downloads a specific dataset.
kaggle competitions submit -c -f -m : Submits a prediction file to a competition with a message.

HISTORY

The Kaggle CLI was developed to provide programmatic access to the Kaggle platform. It has been actively maintained and improved over time to support new Kaggle features and enhance user experience. The usage has grown with popularity of Kaggle and its community, becoming a standard tool in many data scientists' workflows.

Copied to clipboard