graphdoc.main module

graphdoc.main.log = <Logger graphdoc.main (WARNING)>

Run GraphDoc as a command-line application.

This module can be run directly to train models, generate documentation, or evaluate documentation quality.

Usage:

python -m graphdoc.main –config CONFIG_FILE [–log-level LEVEL] COMMAND [ARGS]

Global Arguments:

--config PATH

Path to YAML configuration file with GraphDoc and language model settings

--log-level LEVEL

Set logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) Default: INFO

Commands:

train Train a prompt using a dataset

--trainer-config PATH

Path to trainer YAML configuration

generate Generate documentation for schema files

--module-config PATH

Path to module YAML configuration

--input PATH

Path to input schema file or directory

--output PATH

Path to output file

evaluate Evaluate documentation quality

--eval-config PATH

Path to evaluator YAML configuration

Examples

# Train a documentation quality model python -m graphdoc.main –config config.yaml train –trainer-config trainer_config.yaml

# Generate documentation for schemas python -m graphdoc.main –config config.yaml generate –module-config module_config.yaml –input schema.graphql –output documented_schema.graphql

# Evaluate documentation quality python -m graphdoc.main –config config.yaml evaluate –eval-config eval_config.yaml

Configuration:

See example YAML files in the documentation for format details.