pipeline#

Functions#

instiantiate(x)

instiantiate_pipeline(pipeline[, language, model, ...])

pipeline(pipeline_file, input_dir, language, ...[, ...])

Module Contents#

pipeline.instiantiate(x)#
pipeline.instiantiate_pipeline(pipeline, language='text', model='gpt-4o', use_janus_inputs=None)#
Parameters:

  • pipeline (list[dict]) –

  • language (str) –

  • model (str) –

  • use_janus_inputs (None | bool) –

pipeline.pipeline(pipeline_file, input_dir, language, output_dir, llm_name, failure_dir=None, overwrite=False, use_janus_inputs=None)#
Parameters:

  • pipeline_file (typing_extensions.Annotated[pathlib.Path, typer.Option('-p', '--pipeline', help='Name of pipeline file to use')]) –

  • input_dir (typing_extensions.Annotated[pathlib.Path, typer.Option('--input', '-i', help='The directory containing the source code to be translated. The files should all be in one flat directory.')]) –

  • language (typing_extensions.Annotated[str, typer.Option('--language', '-l', help='The language of the source code.', click_type=click.Choice(sorted(LANGUAGES)))]) –

  • output_dir (typing_extensions.Annotated[pathlib.Path, typer.Option('--output', '-o', help='The directory to store the translated code in.')]) –

  • llm_name (typing_extensions.Annotated[str, typer.Option('--llm', '-L', help="The custom name of the model set with 'janus llm add'.")]) –

  • failure_dir (typing_extensions.Annotated[Optional[pathlib.Path], typer.Option('--failure-directory', '-f', help='The directory to store failure files during documentation')]) –

  • overwrite (typing_extensions.Annotated[bool, typer.Option('--overwrite/--preserve', help='Whether to overwrite existing files in the output directory')]) –

  • use_janus_inputs (typing_extensions.Annotated[Optional[bool], typer.Option('-j', '--use-janus-inputs', help='Present if converter chain should use janus input files')]) –