utils

some utility functions

get_webapp_dir

 get_webapp_dir ()

Get the webapp directory path

source

get_models_dir

 get_models_dir ()

Get the models directory path

source

get_datadir

 get_datadir (subfolder=None)

*Get the data directory path, optionally with a subfolder. Creates the main data dir and any requested subfolder if they don’t exist.

Args: subfolder: Optional subfolder name to append to the data directory path

Returns: Path to the data directory or subfolder*

source

download

 download (url, filename, verify=False)

source

df_to_md

 df_to_md (df, caption=None)

Converts pd.Dataframe to markdown

source

html_to_df

 html_to_df (html_str:str)

Convert HTML to dataframe.

source

md_to_df

 md_to_df (md_str:str)

Convert Markdown to dataframe.

source

contains_sentence

 contains_sentence (sentence, text)

Returns True if sentence is contained in text ignoring whether tokens are delmited by spaces or newlines or tabs.

source

remove_sentence

 remove_sentence (sentence, text, remove_follow=False,
                  flags=re.IGNORECASE)

*Removes a sentence or phrase from text ignoring whether tokens are delimited by spaces or newlines or tabs.

If remove_follow=True, then subsequent text until the first newline is also removed.*

source

segment

 segment (text:str, unit:str='paragraph', maxchars:int=2048)

Segments text into a list of paragraphs or sentences depending on value of unit (one of {'paragraph', 'sentence'}. The maxchars parameter is the maximum size of any unit of text.

source

filtered_generator

 filtered_generator (generator, criteria=[])

*Filters a generator based on a given predicate function.

Args: generator: The generator to filter. criteria: List of functions that take an element from the generator and return True if the element should be included, False otherwise.

Yields: Elements from the original generator that satisfy the predicate.*

source

batch_generator

 batch_generator (iterable, batch_size)

Batched results from generator

source

batch_list

 batch_list (input_list, batch_size)

Split list into chunks

source

get_template_vars

 get_template_vars (template_str:str)

Get template variables from a template string.

source

format_string

 format_string (string_to_format:str, **kwargs:str)

Format a string with kwargs

source

SafeFormatter

 SafeFormatter (format_dict:Optional[Dict[str,str]]=None)

Safe string formatter that does not raise KeyError if key is missing. Adapted from llama_index.