piel.experimental.text

piel.experimental.text#

Functions#

append_image_path_list_to_markdown(image_path_list, ...)

Appends a list of image paths to a markdown file.

write_schema_markdown(schema_json_file, ...)

This function writes the schema markdown file for the experiment configuration. This schema markdown file should

write_experiment_top_markdown(experiment, ...[, ...])

Module Contents#

append_image_path_list_to_markdown(image_path_list: list[str], markdown_file: str)[source]#

Appends a list of image paths to a markdown file.

Parameters:

  • image_paths (list) – A list of image file paths to be added to the markdown file.

  • markdown_file (str) – The path to the markdown file.

write_schema_markdown(schema_json_file: piel.types.PathTypes, target_markdown_file: piel.types.PathTypes)[source]#

This function writes the schema markdown file for the experiment configuration. This schema markdown file should contain all the required information to understand the experiment configuration. This should include all the experiment instances and their corresponding configurations.

write_experiment_top_markdown(experiment: piel.types.experimental.Experiment, experiment_directory: piel.types.PathTypes, target_markdown_file: piel.types.PathTypes = None)[source]#
Contents