Definition

An AI artifact package is a directory containing AI artifacts.

An AI artifact package always contain a metadata file called package.yml.

This schema of the file is described below.

Catalog of AI Artifacts

type	object
properties
name	type	string
metadata	Metadata for AI Artifacts
subpackages	List of packages included in this package
	type	array
	items	type	object
		properties
		pattern	Shell glob pattern
			type	string
		exclude	Shell glob patterns of directories to exclude
			type	array
		additionalProperties	False
artifacts	List of artifacts that are contained in this package (used for reflection)
	type	array
	items	type	object
		properties
		type	Type of artifact
			type	string
		pattern	Shell glob pattern
			type	string
		exclude	Shell glob patterns of files to exclude
			type	array
		additionalProperties	False

Meta Data

All AI artifacts contain a property metadata that describes them.

The schema of this section is the following:

Metadata for AI Artifacts

type	object
properties
title	A short name of the AI Artifact
	type	string
description	A long form description in RSTructured text format
	type	string
references	Describes external resources that may be useful to understand the challenge
	type	array
	items	type	object
		properties
		role	The type of reference
			type	string
			enum	code, paper, presentation, other
		title	The title for the resource.
			type	string
		url	The url from which the resource can be downloaded (can be a link relative to the url of the challenge file)
			type	string
		additionalProperties	False
license	Path to the license file that describes the license of this object
	type	string
author	type	object
	properties
	name	type	string
	email	type	string
	additionalProperties	False
extra	Additional metadata with third party schemas
	type	array
	items	type	object
		properties
		id	ID indentifying the type of extra metadata
			type	string
		value	Extra metadata with the schema specified by the schema property
		schema	URL where the schema for the metadata can be obtained
			type	string
			format	uri
additionalProperties	False

Create Package

This guide assumes you already have the done the following:

• Setup the local environment as explained in Prerequisites

All AI Artifacts managed by the Bonseyes tooling process are stored in packages. Packages are directories in the local file system. Thanks to their globally unique name they can be replicated on multiple hosts, re-organized according in a file structure most appropriate for each project and shared between multiple organizations participating in the AI development process.

Each package has a unique name. To ensure that it is globally unique the package name must always start with the domain name of the organization in reverse underscore notation (i.e. for the organization “Example Inc” with domain name example.com the package name must start with com_example). The rest of the package name is an identifier that can be choosen freely by the organization.

The following are examples of valid package names:

• com_example/mychallenge

• com_example/challenges/mychallenge

• com_example/models/mymodel

To create a package you can use the following command:

$ bonseyes package create ${PACKAGE_DIR} --name ${PACKAGE_NAME}

where ${PACKAGE_DIR} should be substituted with the directory where the package should be stored and ${PACKAGE_NAME} should be substituted with the name of the package being created.