Skip to content
bar-chart-2

GitHub Action

Generate VerifyML Report

v1.0.10 Latest version

Generate VerifyML Report

bar-chart-2

Generate VerifyML Report

Automated documentation of model and alerts from performance / fairness checks

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Generate VerifyML Report

uses: cylynx/[email protected]

Learn more about this action in cylynx/verifyml-reports

Choose a version

cylynx/verifyml-reports

This action provides the following functionality for GitHub Actions users:

  • Read the Protobuf dataset from a specified path in local repository and display the test results as comment in the pull request.
  • Generate Model Card Viewer link for user to view the model card data.

Usage

See action.yml

name: Generate VerifyML Report

on:
  pull_request:
    branches:
      - '*'

jobs:
  report-generation:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout to Current Branch
        uses: actions/checkout@v2

      - name: Generate VerifyML Report
        uses: cylynx/verifyml-reports@v1
        with:
          data-path: '/examples/model_card_output/data/loan_approval_example.proto'

The data-path input is required - the action will read the model card from the given path and use it to generate the test results.