piel.experimental.text
======================

.. py:module:: piel.experimental.text


Functions
---------

.. autoapisummary::

   piel.experimental.text.append_image_path_list_to_markdown
   piel.experimental.text.write_schema_markdown
   piel.experimental.text.write_experiment_top_markdown


Module Contents
---------------

.. py:function:: append_image_path_list_to_markdown(image_path_list: list[str], markdown_file: str)

   Appends a list of image paths to a markdown file.

   :param image_paths: A list of image file paths to be added to the markdown file.
   :type image_paths: list
   :param markdown_file: The path to the markdown file.
   :type markdown_file: str


.. py:function:: write_schema_markdown(schema_json_file: piel.types.PathTypes, target_markdown_file: piel.types.PathTypes)

   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.



.. py:function:: write_experiment_top_markdown(experiment: piel.types.experimental.Experiment, experiment_directory: piel.types.PathTypes, target_markdown_file: piel.types.PathTypes = None)