Prediction site

These schemas specify how the prediction site is configured and how the data used by the visualization is formatted. The Prediction API makes use of these schemas as well as some metadata schemas.

Prediction branches

https://gros.liacs.nl/schema/prediction-site/branches.json

branches

branches

type	object
properties
jobs	type	array
	items	type	object
		properties
		name	Name of a branch. Only branches which start with the organization name and a dash are available on an endpoint for a specific organization (with this part stripped), while a combined endpoint has a subset of the other branches (not matching any of the known organizations).
			type	string
			pattern	^[-_0-9a-zA-Z]+$
		lastStableBuild	type	object
			properties
			description	Description of the branch.
				oneOf	type	string
					type	null
			duration	Number of milliseconds that the latest prediction run for this branch took.
				type	integer
				minimum	0
			timestamp	Number of milliseconds since the UNIX epoch (January 1, 1970 at 00:00:00) at the moment that the latest prediction run for this branch started.
				type	integer
				minimum	0

Prediction site configuration

https://gros.liacs.nl/schema/prediction-site/config.json

config-prediction-site

config-prediction-site

type	object
properties
prediction_url	type	string
	format	uri-reference
language	type	string
	pattern	^[a-zA-Z]{2,3}(-.*)?$
organizations	Locales
branches_url	type	string
	format	uri-reference
branches_filter	oneOf	type	object
		properties
		combined	branches_filter
		default	branches_filter
		branches_filter
branches_alter	oneOf	type	object
		properties
		combined	branches_alter
		default	branches_alter
		branches_alter
branch_url	type	string
	format	uri-reference
master_url	type	string
	format	uri-reference
files_url	type	string
	format	uri-reference
papers_url	type	string
	format	uri-reference
jira_url	type	string
	format	uri
openapi_url	type	string
	format	uri-reference
allOf	config-visualization

branches_filter

type	string
format	regex

branches_alter

type	string
format	regex

Prediction model configuration

https://gros.liacs.nl/schema/prediction-site/configuration.json

configuration

configuration

type	object
properties
label	type	object
	properties
	expression	Expression of the label used as target output in the model.
		type	string
	attributes	type	array
		items	Name of a feature used as part of the expression for the target output label.
			type	string
assignments	type	object
	patternProperties
	.*	type	object
		properties
		expression	Expression that is used to assign the generated feature.
			type	string
		attributes	type	array
			items	Feature used in an assignment of another generated feature.
				type	string
organizations	type	array
	items	Identifier of an organization whose projects and sprints are used in the data set.
		type	string
features	type	array
	items	Name of a feature used as input for the model.
		type	string
metadata	type	array
	items	Name of a column of the data set used as metadata.
		type	string
model	Identifier of the model used.
	type	string
binary	Treshold at which a label value is converted to a binary classification, if provided.
	oneOf	type	number
		type	null
weighted	Whether input values were weighted to produce values at similar scales as input for the model.
	type	boolean
stratified	Whether the data set was resampled (some sample sprints provided more often) in order to create proportionally balanced subsets with normal distributions of the target label, when provided in batches to the model.
	type	boolean
min_date	Earliest date and time of the sprints included in the data set that this model was trained/tested/validated on.
	type	string
	format	date-time
max_date	Latest date and time of the sprints included in the data set that this model was trained/tested/validated on.
	type	string
	format	date-time

Prediction files

https://gros.liacs.nl/schema/prediction-site/files.json

files

files

type	object
properties
data	type	object
	properties
	files	type	array
		items	file

file

type	object
properties
type	Kind of the file. dir: A directory. file: A regular file.
	type	string
	enum	dir, file
mimetype	MIME type of the file.
	type	string
	pattern	^[a-z-]+/[a-z-]+$
name	Filename of the file.
	type	string

Sprint prediction

https://gros.liacs.nl/schema/prediction-site/sprint_prediction.json

sprint_prediction

sprint_prediction

type	object
properties
prediction	Classification or estimation label for the sprint from the model.
	type	integer
probability	oneOf	Reliability of the predicted label for the sprint according to the estimator model.
		type	number
		maximum	1.0
		minimum	0.0
		type	null
risk	oneOf	Chance that the sprint will receive a negative classification after all, based on internal activations of the estimator model but with external normalized scale.
		type	number
		maximum	1.0
		minimum	0.0
		type	null
metrics	oneOf	type	object
		patternProperties
		.*	type	number
		type	null
analogies	Details on sprints that the model detected to be closest to the sprint.
	oneOf	type	array
		items	analogy
		type	null
configuration	configuration
sources	Information about the age of data retrieved from originating systems.
	type	object
	patternProperties
	.*	datetime
allOf	sprint

sprint

type	object
properties
project	Identifier of the project which the sprint that is being labeled is from.
	type	string
project_id	Internal identifier of the project.
	oneOf	type	string
		type	integer
		minimum	1
sprint	Identifier of the sprint.
	type	integer
	minimum	1
id	Internal identifier of the sprint
	type	integer
	minimum	1
board_id	Identifier of the Scrum board in the issue tracker where the sprint is found.
	oneOf	type	integer
		minimum	1
		type	null
name	Name of the sprint.
	type	string
start_date	The moment that the sprint starts.
	datetime
end_date	The moment that the sprint ends.
	datetime
tags	List of feature names that are applicable to the sprint.
	type	array
	items	type	string

analogy

type	object
properties
label	Labels of the nearby sprint.
	type	integer
allOf	sprint

features

type	object
patternProperties
.*	oneOf	type	number
		type	null

datetime

type	string
pattern	^[1-9][0-9][0-9][0-9]-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) [0-9][0-9]:[0-9][0-9]:[0-9][0-9]$

Prediction sprint list

https://gros.liacs.nl/schema/prediction-site/sprints.json

prediction-sprints

prediction-sprints

Sprints for which a prediction is available.
type	array
items	type	object
	properties
	name	The name of the sprint.
		type	string
	sprint_num	The sequential number of the sprint in the project’s lifespan.
		type	integer
		minimum	1
	sprint_id	Identifier of the sprint.
		type	integer
		minimum	1