-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
10 changed files
with
500 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
name: "Release" | ||
on: | ||
push: | ||
branches: | ||
- main | ||
tags: | ||
- "v*" | ||
workflow_dispatch: {} | ||
|
||
jobs: | ||
release: | ||
uses: RiverBench/ci-workflows/.github/workflows/category-release.yaml@main | ||
permissions: write-all | ||
secrets: inherit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/out | ||
/doc_out |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,5 @@ | ||
# category-template | ||
Template repository for new benchmark categories | ||
|
||
Template for new benchmark categories. See the [documentation about categories](https://w3id.org/riverbench/documentation/categories) for information on how to use it. | ||
|
||
Do not edit this README. It will be overwritten automatically when you complete setting up the metadata of the category. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Put any additional Markdown files or images here for inclusion in the docs of the category. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
@prefix : <https://w3id.org/riverbench/temp#> . | ||
@prefix dcterms: <http://purl.org/dc/terms/> . | ||
@prefix foaf: <http://xmlns.com/foaf/0.1/> . | ||
@prefix rb: <https://w3id.org/riverbench/schema/metadata#> . | ||
|
||
# This file contains the manually written metadata for the benchmark category. | ||
# The URI of the category here is temporary. Real URIs are assigned automatically in CI. | ||
|
||
:category | ||
a rb:Category ; | ||
dcterms:conformsTo <https://w3id.org/riverbench/schema/metadata> ; | ||
dcterms:identifier "[YOUR CATEGORY ID (only a-z, 0-9, no dashes!)]" ; | ||
dcterms:title "[HUMAN-READABLE NAME OF YOUR CATEGORY]"@en ; | ||
dcterms:description """[ELABORATED DESCRIPTION OF THE CATEGORY]"""@en ; | ||
. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Profiles | ||
|
||
This directory contains the definitions of benchmark profiles in this category. | ||
|
||
See `template.ttl` for a template to create a new profile. | ||
|
||
Full instructions are available in the **[documentation](https://w3id.org/riverbench/documentation/categories)**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
@prefix : <https://w3id.org/riverbench/profiles/> . | ||
@prefix dcat: <http://www.w3.org/ns/dcat#> . | ||
@prefix dcterms: <http://purl.org/dc/terms/> . | ||
@prefix rb: <https://w3id.org/riverbench/schema/metadata#> . | ||
@prefix stax: <https://w3id.org/stax/ontology#> . | ||
|
||
# This file is a template for creating a new profile. | ||
# Copy this file and replace the placeholders with the actual values. | ||
|
||
:__ID__ | ||
a dcat:DatasetSeries, rb:Profile ; | ||
# The profile ID must be unique and must start with the ID of the category it belongs to. | ||
# For example, all profiles in the "stream" category must start with "stream-". | ||
dcterms:identifier "[PROFILE ID (SAME AS __ID__), only a-z, 0-9, and -]" ; | ||
dcterms:title "[HUMAN-READABLE NAME OF THE PROFILE]" ; | ||
dcterms:description "[ELABORATED DESCRIPTION OF THE PROFILE]" ; | ||
# Optional: if this profile is a superset of another profile, specify the ID of the other profile here. | ||
rb:isSupersetOfProfile :__ID_OF_SUBPROFILE__ ; | ||
|
||
# Specify the shapes of datasets and distributions that are valid for this profile. | ||
# Use the shapes defined in the shapes library in the schema repository: | ||
# https://github.com/RiverBench/schema/tree/main/src/lib/profiles | ||
rb:hasDatasetShape [ | ||
sh:targetClass rb:Dataset ; | ||
sh:property lib:LIST-RESTRICTIONS-HERE ; | ||
] ; | ||
rb:hasDistributionShape lib:LIST-RESTRICTIONS-HERE ; | ||
. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Benchmark tasks | ||
|
||
This directory contains the benchmark tasks of this category. To create a new task, create a new subfolder here named after the task, copy the "metadata.ttl" file from here into the new folder, and edit it to describe the task. | ||
|
||
Full instructions are available in the **[documentation](https://w3id.org/riverbench/documentation/categories)**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
@prefix : <https://w3id.org/riverbench/temp#> . | ||
@prefix dcterms: <http://purl.org/dc/terms/> . | ||
@prefix foaf: <http://xmlns.com/foaf/0.1/> . | ||
@prefix rb: <https://w3id.org/riverbench/schema/metadata#> . | ||
@prefix rbdoc: <https://w3id.org/riverbench/schema/documentation#> . | ||
|
||
# This file is a template for a benchmark task metadata file. | ||
# The URI of the task here is temporary. Real URIs are assigned automatically in CI. | ||
|
||
:task | ||
# General information | ||
a rb:Task ; | ||
dcterms:conformsTo <https://w3id.org/riverbench/schema/metadata> ; | ||
# The task ID must be unique and must start with the ID of the category it belongs to. | ||
# For example, all tasks in the "stream" category must start with "stream-". | ||
dcterms:identifier "[YOUR TASK ID (only a-z, 0-9, and -)]" ; | ||
dcterms:title "[HUMAN-READABLE NAME OF YOUR TASK]"@en ; | ||
dcterms:description "[ELABORATED DESCRIPTION OF THE TASK]"@en ; | ||
|
||
# Authors | ||
# Feel free to add more creators or use any FOAF properties here | ||
dcterms:creator [ | ||
foaf:name "[YOUR NAME]" ; | ||
foaf:nick "[YOUR NICK]" ; | ||
foaf:homepage <LINK-TO-YOUR-PAGE> ; | ||
# Optional: use this property to order creators in the generated docs | ||
rbdoc:hasDocWeight 1 ; | ||
] | ||
. |