Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/source/adding-mutant-generation.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,26 @@
Adding a Mutant Generation Approach
===================================

To add a mutant generation approach to *multiplex*, users should create a package for their approach in the ``multiplex/approach/`` directory.

Users can copy the ``basic`` example to get started and then build their own approach using the underlying setup.

Each approach has a ``controller.py`` file that is called by ``multiplex/__main__.py``.
Currently users must add their approach call to ``__main__.py`` following the template of the existing approaches.

.. code-block:: Python

"""Controller for Basic prompt approach."""

from approach.basic.code_generator import generate_code


def main(model, output_dir, prompts, language):
"""Controller for Basic prompt approach"""

generate_code(model, output_dir, prompts["basic_generate_mutants"], language)


def __main__(model, output_dir, prompts, language):
main(model, output_dir, prompts, language)

2 changes: 0 additions & 2 deletions docs/source/architecture.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/source/configuration.rst

This file was deleted.

Loading