https://github.com/smly/vscode-fast-kaggle

VS Code Extension for Kaggle
https://github.com/smly/vscode-fast-kaggle

kaggle vscode-extension

Last synced: 5 months ago
JSON representation

VS Code Extension for Kaggle

• Host: GitHub
• URL: https://github.com/smly/vscode-fast-kaggle
• Owner: smly
• License: mit
• Created: 2024-11-24T07:05:03.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-12-09T16:28:08.000Z (7 months ago)
• Last Synced: 2024-12-09T17:37:33.364Z (7 months ago)
• Topics: kaggle, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=smly.fastkaggle
• Size: 529 KB
• Stars: 14
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# VS Code Extension for Kaggle

[![Version](https://vsmarketplacebadges.dev/version-short/smly.fastkaggle.svg)](https://marketplace.visualstudio.com/items?itemName=smly.fastkaggle)

Simplify your Kaggle workflow: Update and manage datasets and kernels directly within VS Code.

## Prerequisites

This extension leverages the `kaggle` command-line tool for interacting with Kaggle. You'll need to have the [Kaggle CLI](https://github.com/Kaggle/kaggle-api) installed and configured on your machine.

### Extension Settings

This extension contributes the following setting:

* `fastkaggle.executablePath`: Path to the `kaggle` executable. If the `kaggle` command is in your system's PATH, you can use this extension without modifying this setting.

## Features

### Update Datasets and Notebooks

* **Shortcut**: Ctrl+Shift+U.

* **Command Palette**: Cmd+Shift+P then select "Kaggle: Update Dataset/Notebook".

![command palette](./images/command_palette_update.png)

This command automatically detects the `dataset-metadata.json` or `kernel-metadata.json` file in the current file's directory or its parent directories. It then uses that directory as the working directory for executing the Kaggle update command.

#### Check Update Status

Quickly check the status of your updated datasets and notebooks by pressing Cmd+Shift+K. This is especially useful for monitoring long-running notebooks. ✨

### Create Datasets and Notebook

* **Command Palette**: Cmd+Shift+P then select "Kaggle: New Dataset" or "Kaggle: New Notebook".

This command will generate metadata and a plain jupyter notebook. It helps you quickly create new notebooks and datasets.

### Metadata Validation

The extension validates the JSON schema of `kernel-metadata.json` and `dataset-metadata.json` files, ensuring your Kaggle dataset and notebook definitions are correct.

![validation](./images/validate_metadata.png)

### Sidebar View for Datasets, Notebooks and Models

The extension provides a sidebar view for datasets, notebooks and models.

![Sidebar View](./images/sidebar_view.png)

Right-click on a dataset or notebook in the sidebar to access a context menu, allowing you to check its status.

![Context Menu](./images/sidebar_view_status.png)

The status is displayed based on the output of the kaggle status subcommand.

![Status Result](./images/output_status.png)

### List Competitions

**Command Palette**: Cmd+Shift+P then select "Kaggle: List Competitions".

Lists recent competitions sorted by deadline. This executes `kaggle competitions list` and displays the output.

![List Competitions](./images/competition_list.png)

**Enjoy your Kaggle journey with FastKaggle!**