evidence

package

v0.10.0 Latest Latest Go to latest Published: Mar 9, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/NVIDIA/aicr

Links

Open Source Insights

Documentation ¶

Overview ¶

Package evidence renders CNCF AI Conformance evidence markdown from CTRF reports.

Index ¶

func GetRequirement(validatorName string) *requirementMeta
type Option
- func WithOutputDir(dir string) Option
type Renderer
- func New(opts ...Option) *Renderer
- func (r *Renderer) Render(ctx context.Context, report *ctrf.Report) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetRequirement ¶ added in v0.9.0

func GetRequirement(validatorName string) *requirementMeta

GetRequirement returns the requirement metadata for a validator name. Returns nil if the validator is not a submission-required conformance check.

Types ¶

type Option ¶

type Option func(*Renderer)

Option configures a Renderer.

func WithOutputDir ¶

func WithOutputDir(dir string) Option

WithOutputDir sets the output directory for evidence files.

type Renderer ¶

type Renderer struct {
	// contains filtered or unexported fields
}

Renderer generates CNCF conformance evidence documents from CTRF reports.

func New ¶

func New(opts ...Option) *Renderer

New creates a new evidence Renderer with the given options.

func (*Renderer) Render ¶

func (r *Renderer) Render(ctx context.Context, report *ctrf.Report) error

Render generates evidence markdown files from a CTRF report. Groups test results by CNCF requirement. Only submission-required checks produce evidence. Skipped tests are excluded.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL