Installation

To install Openlake, simply use pip:

$ pip install --constraint https://raw.githubusercontent.com/formlio/openlake/main/constraints.txt 'openlake[all]'

Extra Options

Feature

Install Command

Description

all

pip install 'openlake[all]'

All providers

dev

pip install 'openlake[dev]'

Openlake development tools

docs

pip install 'openlake[docs]'

Documentation publishing dependencies

kaggle

pip install 'openlake[kaggle]'

Kaggle datasets provider

sklearn

pip install 'openlake[sklearn]'

Scikit-learn datasets provider

providers

pip install 'openlake[providers]'

All providers combined

Configuration

This Openlake feed becomes available within the ForML platform after referencing it from the platform configuration. Following is snippet of the configuration file enabling the openlake.Lite feed:

config.toml
 [FEED.openlake]
 provider = "openlake:Lite"

Kaggle API Authentication

In order to fetch the datasets using the Kaggle API, you must first configure your access token stored under the ~/.kaggle/kaggle.json. For more details, see the Kaggle API Documentation.

Attention

You must read and accept the rules of each individual Kaggle competition in order to download its dataset. This cannot be done programmatically - you must do this by visiting the Kaggle website and accepting the rules there.