Create experiment comparison markdown table for Github actions

Create a markdown file with an experiment comparison table.

Get a diff between experimenst across metrics, parameters, and properties and save it to a file as a markdown table.

neptunecontrib.create_experiment_comparison_comment.experiment_ids

Experiment ids of experiments you would like to compare. It works only for 2 experiments. You can pass it either as –experiment_ids or -e. For example, –experiment_ids GIT-83 GIT-82.

Type:list(str)
neptunecontrib.create_experiment_comparison_comment.tag_names

tags of experiments you would like to compare. It works of tags passed are unique to the experiments they belong to. You can pass it either as –tag_names or -n. For example, –tag_names a892ee0ds 09asajd902.

Type:list(str)
neptunecontrib.create_experiment_comparison_comment.api_token

Neptune api token. If you have NEPTUNE_API_TOKEN environment variable set to your API token you can skip this parameter. You can pass it either as –neptune_api_token or -t.

Type:str
neptunecontrib.create_experiment_comparison_comment.project_name

Full name of the project. E.g. “neptune-ai/neptune-examples”, If you have PROJECT_NAME environment variable set to your Neptune project you can skip this parameter. You can pass it either as –project_name or -p.

Type:str
neptunecontrib.create_experiment_comparison_comment.filepath

filepath of the output markdown file. You can pass it either as –filepath or -f.

Type:str

Example

Create a file, comparison.md, with a comparison table of experiments GIT-83 and GIT-82:

$ python -m neptunecontrib.create_experiment_comparison_comment
    --experiment_ids GIT-83 GIT-82
    --api_token ANONYMOUS
    --project_name shared/neptune-actions
    --filepath comment_body.md

Note

If you keep your neptune api token in the NEPTUNE_API_TOKEN environment variable you can skip the –api_token. If you keep your full neptune project name in the PROJECT_NAME environment variable you can skip the –project_name.