framex.about

about(name: str, mode: Literal['print', 'row'] = 'print') → None | polars.DataFrame

Print or return information about a dataset.

Parameters:

• name (str) – Name of the dataset.

• mode ({'print', 'row'}) –

  The mode to print information. Default is ‘print’

  print: prints the information row: returns the information as a single row polars.DataFrame

Returns:

None

Examples

In default ‘print’ mode.

import framex as fx

fx.about("mpg")

NAME    : mpg
SOURCE  : https://www.kaggle.com/datasets/uciml/autompg-dataset
LICENSE : CC0: Public Domain
ORIGIN  : Kaggle
DOC     : https://www.kaggle.com/datasets/uciml/autompg-dataset
OG NAME : autompg-dataset

In ‘row’ mode.

import framex as fx

fx.about("mpg",mode='row')

shape: (1, 5)

name	source	license	origin	doc
str	str	str	str	str
"mpg"	"https://www.kaggle.com/dataset…	"CC0: Public Domain"	"Kaggle"	"https://www.kaggle.com/dataset…