Skip to main content

Documentation Index

Fetch the complete documentation index at: https://kumo.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

column_processing configures how Kumo encodes and imputes columns.

​
na_strategy (Optional)

Use na_strategy to set global N/A handling by semantic type.

​
Supported Task Types

  • All
na_strategy:
    <semantic_type>: <na_strategy>

​
Example

This example applies na_strategy="separate" to all numerical columns and na_strategy="most_frequent" to categorical columns. 
na_strategy:
    numerical: separate
    categorical: most_frequent

​
Supported Semantic Types

  • numerical
  • categorical
  • ID
  • multicategorical
  • text
  • timestamp
  • sequence
Only strategies supported by each semantic type’s encoder are valid. Unsupported combinations fail model plan validation.

​
encoder_overrides (Optional)

The encoder_overrides field allows you to configure the way Kumo processes your input data and override the encoders that are inferred by Kumo.

​
Supported Task Types

  • All
Nested fields require exactly four spaces. Each column must be specified with two case sensitive fields: 
encoder_overrides:
    <table_name>.<column_name>: <encoder>

​
Example

This example overrides three of the columns in MOVIES table to change the default behavior. 
encoder_overrides:
    MOVIES.overview: GloVe(model_name="glove.42B", embedding_dim=300)
    MOVIES.tag_line: Null()
    MOVIES.budget: Numerical(scaler="minmax", na_strategy="zero")
With this example above, Kumo handles the overriden columns as follows:
  • For text column MOVIES.overview, it uses the model "glove.42B" instead of the default "glove.6B". See “GloVe Argument Combinations” section below on this page for available options, and see GloVe project for details.
  • Kumo ignores the column MOVIES.tag_line, and the column has no impact on modelling as it is set to Null().
  • For numerical column MOVIES.budget, Kumo scales numerical values within the range [0, 1] as it is set to "minmax" instead of the default "standard".

​
Precedence

Kumo applies column_processing overrides in this order:
  1. na_strategy global semantic-type overrides.
  2. encoder_overrides per-column overrides.
If both are set for the same column, encoder_overrides wins.

​
Supported Encoders

Column TypeEncoderArgumentDefaultSupported ValueDescription
Categorical, IDIndexna_strategy"separate""zero"``"separate"``"most_frequent"When set to "zero", embeddings for missing values are represented as zero vectors. When set to "separate", missing values are treated as a distinct category. When set to "most_frequent", missing values are assigned to the most prevalent category.
Categorical, IDIndexmin_occ1positive integerThe minimal count to allow within each category. If a category count is lower than min_occ, Kumo treats the category as N/A.
Categorical, IDHashna_strategy"separate""zero"``"separate"``"most_frequent"When set to "zero", embeddings for missing values are represented as zero vectors. When set to "separate", missing values are treated as a distinct category. When set to "most_frequent", missing values are assigned to the most prevalent category.
Categorical, IDHashnum_componentsDepends on cardinality of the columnpositive integerThe capacity of the hash table.
Categorical, IDHashmin_occDepends on cardinality of the columnpositive integerThe minimal count to allow within each category. If a category count is lower than min_occ, Kumo treats the category as N/A.
Categorical, IDHashna_strategy"zero""zero"``"separate"``"most_frequent"When set to "zero", embeddings for missing values are represented as zero vectors. When set to "separate", missing values are treated as a distinct category. When set to "most_frequent", missing values are assigned to the most prevalent category.
MulticategoricalMultiCategoricalmin_occ1positive integerThe minimal count to allow within each category. If a category count is lower than min_occ, Kumo treats the category as N/A.
MulticategoricalMultiCategoricalsepInferred by KumostringThe separator to use.
NumericalNumericalscalerNoneNone``"standard"``"minmax"``"robust"When set to None, no transformation is applied to the column values. When set to "standard", the column values are transformed to have zero mean and unit variance. When set to "minmax", the values are scaled to fall within the range [0, 1]. When set to "robust", values are subtracted from the feature’s median and divided by the interquartile range.
NumericalNumericalna_strategy"mean""mean"``"zero"``"separate"If "mean", N/A values are replaced with the mean value of the column. If "zero", N/A values are replaced with zero. If "separate", missingness is preserved as a dedicated learnable signal.
NumericalMaxLogNumericalna_strategy"mean""mean"``"zero"If "mean", N/A values are replaced with the mean value of the column. If "zero", N/A values are replaced with zero.
NumericalMinLogNumericalna_strategy"mean""mean"``"zero"If "mean", N/A values are replaced with the mean value of the column. If "zero", N/A values are replaced with zero.
EmbeddingNumericalListna_strategy"zero""zero"If "zero", N/A values are replaced with zero.
TimestampDatetimeinclude_minutetruetrue``falseWhether to include minute.
TimestampDatetimeinclude_hourtruetrue``falseWhether to include hour.
TimestampDatetimeinclude_day_of_weektruetrue``falseWhether to include day of week.
TimestampDatetimeinclude_day_of_monthtruetrue``falseWhether to include day of month.
TimestampDatetimeinclude_day_of_yeartruetrue``falseWhether to include day of year.
TimestampDatetimeinclude_yeartruetrue``falseWhether to include year.
TimestampDatetimenum_year_periodsDepends on the difference between the min and max year in the columnpositive integerThe number of periods to consider for encoding years, e.g., in case num_year_periods=4, year is encoded as year % i for each i in { 2, 4, 8, 16 }. If set to None, it will be inferred based on dataset statistics.
TextGloVemodel_name"glove.6B""glove.6B"``"glove.42B"``"glove.840B"``"glove_twitter.27B"The pretrained model name.
TextGloVeembedding_dim5025``50``100``200``300The embedding dimension of the pretrained model. Note that not all models support these embedding dimensions. See the GloVe Argument Combinations table below.
Any typeNulln/an/an/aIf Null is specified to a column, Kumo ignores this column completely.

​
GloVe Argument Combinations

On SPCS, only the GloVe model glove.6B with an embedding size of 50 is currently supported.
model_nameembedding_dim
"glove.6B"50, 100, 200, 300
"glove.42B"300
"glove.840B"300
"glove_twitter.27B"25, 50, 100, 200