cobs_index.compact_construct_list

compact_construct_list(list: cobs_index.DocumentList, out_file: str, index_params: cobs_index.CompactIndexParameters = <cobs_index.CompactIndexParameters object at 0x7f49d2030650>, tmp_path: str = '') → None

Construct a COBS Compact Index from a pre-populated DocumentList object.

Parameters

  • input (DocumentList) – DocumentList object of documents to index

  • out_file (str) – path to the output .cobs_compact index file

  • index_params (CompactIndexParameters) – instance of compact index parameter object

  • tmp_path (str) – directory for intermediate index files, default: out_file + .tmp