Skip to main content

Module dictionary

Module dictionary 

Source
Available on crate feature dict_builder only.
Expand description

Code for creating a separate content dictionary.

Effective dictionaries are up to 1% the size of the complete training body, and are trained on many examples of the original data.

Implemented following the paper “Effective construction of Relative Lempel-Ziv Dictionaries”, by Kewen Liao, Matthias Petri, Alistair Moffat, and Anthony Wirth

Structs§

DictionaryTrainerOptions
Options for producing a standard formatted Zstandard dictionary.

Enums§

DictionaryTrainingError
Failures reported before or during formatted dictionary training.

Functions§

create_raw_dict_from_dir
Creates a “raw content” dictionary, training off of every file in this directory and all sub-directories.
create_raw_dict_from_source
Read from source to create a “raw content” dictionary of dict_size. The completed dictionary is written to output.
train_dictionary
Trains a standard formatted dictionary from independent representative samples.