From 766c20a6dc8330f913186299e4fae18e3fbdb26e Mon Sep 17 00:00:00 2001
From: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 19 Sep 2024 13:34:00 +0000
Subject: [PATCH] Automatic update of schema docs (dev)
---
docs/schema/documentation.md | 2 +-
docs/schema/metadata.md | 33 ++++++++++++++++++++-------------
2 files changed, 21 insertions(+), 14 deletions(-)
diff --git a/docs/schema/documentation.md b/docs/schema/documentation.md
index 8e9f5c65b..23468e683 100644
--- a/docs/schema/documentation.md
+++ b/docs/schema/documentation.md
@@ -53,7 +53,7 @@ Property | Value
URI | `https://w3id.org/riverbench/schema/documentation#DocGroup`
Description | Documentation group, corresponding to a heading in the generated document.
In range of |[Has documentation group](#hasDocGroup) (ap)
-Has members |[Distributions](#groupDistributions)
[General information](#groupGeneralInfo)
[Technical metadata](#groupTechnicalMetadata)
[Content](#groupContent)
+Has members |[Content](#groupContent)
[Distributions](#groupDistributions)
[Technical metadata](#groupTechnicalMetadata)
[General information](#groupGeneralInfo)
## Object Properties
diff --git a/docs/schema/metadata.md b/docs/schema/metadata.md
index d05c6caf1..c9b26249f 100644
--- a/docs/schema/metadata.md
+++ b/docs/schema/metadata.md
@@ -8,8 +8,7 @@ Markdown documentation created by [pyLODE](http://github.com/rdflib/pyLODE) 2.13
* **URI**
* `https://w3id.org/riverbench/schema/metadata`
* **Creators(s)**
- * [Piotr Sowiński](https://orcid.org/0000-0002-2543-9461)
- [[0000-0002-2543-9461](https://orcid.org/0000-0002-2543-9461)]
+ * [Piotr Sowiński](https://github.com/Ostrzyciel)
* **Created**
* 2023-04-30T00:00:00
* **Issued**
@@ -51,6 +50,7 @@ Ontology for describing datasets and profiles in the RiverBench benchmark suite.
* [ASCII control character count statistics](#AsciiControlCharacterCountStatistics)
* [Benchmark protocol](#BenchmarkProtocol)
* [Blank node count statistics](#BlankNodeCountStatistics)
+* [Bytes per triple (byte density) statistics](#ByteDensityStatistics)
* [Benchmark category](#Category)
* [Member of a benchmark category](#CategoryMember)
* [Custom SHACL target](#CustomShaclTarget)
@@ -101,7 +101,7 @@ Property | Value
URI | `https://w3id.org/riverbench/schema/metadata#BenchmarkProtocol`
Description | The parameters of a performed benchmark (rb:PerformedBenchmark). Instances of this class specify the RiverBench profile, task, systems, and metrics that were used in the benchmark.
Super-classes |[irao:Protocol](http://ontology.ethereal.cz/irao/Protocol) (c)
-Restrictions |[Uses metric](#usesMetric) (dp) **some** [xsd:string](http://www.w3.org/2001/XMLSchema#string) (c)
[Uses system under test](#usesSystemUnderTest) (op) **some** [System under test](#SystemUnderTest) (c)
[Uses benchmark profile](#usesProfile) (op) **some** [Benchmark profile](#Profile) (c)
[Uses benchmark task](#usesTask) (op) **some** [Benchmark task](#Task) (c)
+Restrictions |[Uses benchmark task](#usesTask) (op) **some** [Benchmark task](#Task) (c)
[Uses system under test](#usesSystemUnderTest) (op) **some** [System under test](#SystemUnderTest) (c)
[Uses metric](#usesMetric) (dp) **some** [xsd:string](http://www.w3.org/2001/XMLSchema#string) (c)
[Uses benchmark profile](#usesProfile) (op) **some** [Benchmark profile](#Profile) (c)
### Blank node count statistics
Property | Value
@@ -110,14 +110,21 @@ URI | `https://w3id.org/riverbench/schema/metadata#BlankNodeCountStatistics`
Description | Statistics about the number of blank nodes in the dataset.
Super-classes |[Statistics](#Statistics) (c)
+### Bytes per triple (byte density) statistics
+Property | Value
+--- | ---
+URI | `https://w3id.org/riverbench/schema/metadata#ByteDensityStatistics`
+Description | Statistics about the number of bytes needed to encode a single statement in the N-Triples/N-Quads formats. One newline character is included for each statement. This statistic can be used as a proxy to estimate how much "information" is in an average statement in the dataset when it is uncompressed.
+Super-classes |[Statistics](#Statistics) (c)
+
### Benchmark category
Property | Value
--- | ---
URI | `https://w3id.org/riverbench/schema/metadata#Category`
Description | Class for benchmark categories in RiverBench. A category groups tasks and profiles that are compatible with each other. Each task and profile in a category has a name prefixed with the name of the category (e.g., all tasks in the "stream" category start with "stream-").
Super-classes |[dcat:Resource](http://www.w3.org/ns/dcat#Resource) (c)
-In domain of |[Has category member](#hasCategoryMember) (op)
[Has benchmark task](#hasTask) (op)
[Has benchmark profile](#hasProfile) (op)
-In range of |[In benchmark category](#inCategory) (fp)
[Has benchmark category](#hasCategory) (op)
+In domain of |[Has benchmark task](#hasTask) (op)
[Has benchmark profile](#hasProfile) (op)
[Has category member](#hasCategoryMember) (op)
+In range of |[Has benchmark category](#hasCategory) (op)
[In benchmark category](#inCategory) (fp)
### Member of a benchmark category
Property | Value
@@ -167,7 +174,7 @@ URI | `https://w3id.org/riverbench/schema/metadata#Distribution`
Description | A distribution of a dataset in the RiverBench benchmark suite.
Super-classes |[dcat:Distribution](http://www.w3.org/ns/dcat#Distribution) (c)
Restrictions |[https://w3id.org/stax/ontology#hasStreamTypeUsage](https://w3id.org/stax/ontology#hasStreamTypeUsage) **some** [https://w3id.org/stax/ontology#ConcreteRdfStreamType](https://w3id.org/stax/ontology#ConcreteRdfStreamType) (c)
-In domain of |[Has statistics set](#hasStatisticsSet) (op)
[Has distribution type](#hasDistributionType) (op)
[Has file name](#hasFileName) (dp)
+In domain of |[Has file name](#hasFileName) (dp)
[Has distribution type](#hasDistributionType) (op)
[Has statistics set](#hasStatisticsSet) (op)
### RiverBench distribution type
Property | Value
@@ -175,7 +182,7 @@ Property | Value
URI | `https://w3id.org/riverbench/schema/metadata#DistributionType`
Description | Type of dataset distribution, indicating the corresponding streaming task formulation.
In range of |[Has distribution type](#hasDistributionType) (op)
-Has members |[Jelly distribution](#jellyDistribution)
[Full distribution](#fullDistribution)
[Partial distribution](#partialDistribution)
[Stream distribution](#streamDistribution)
[Flat distribution](#flatDistribution)
+Has members |[Flat distribution](#flatDistribution)
[Full distribution](#fullDistribution)
[Stream distribution](#streamDistribution)
[Jelly distribution](#jellyDistribution)
[Partial distribution](#partialDistribution)
### Graph count statistics
Property | Value
@@ -233,8 +240,8 @@ Property | Value
URI | `https://w3id.org/riverbench/schema/metadata#Profile`
Description | Benchmark profile grouping several datasets in RiverBench. Each profile belongs to one benchmark category (rb:Category).
Super-classes |[Member of a benchmark category](#CategoryMember) (c)
[Dataset series](#DatasetSeries) (c)
-In domain of |[Has distribution shape](#hasDistributionShape) (op)
[Is superset of profile](#isSupersetOfProfile) (op)
[Has dataset shape](#hasDatasetShape) (op)
[Is subset of profile](#isSubsetOfProfile) (op)
-In range of |[Has benchmark profile](#hasProfile) (op)
[Uses benchmark profile](#usesProfile) (op)
[Is superset of profile](#isSupersetOfProfile) (op)
[Is subset of profile](#isSubsetOfProfile) (op)
+In domain of |[Is superset of profile](#isSupersetOfProfile) (op)
[Has distribution shape](#hasDistributionShape) (op)
[Has dataset shape](#hasDatasetShape) (op)
[Is subset of profile](#isSubsetOfProfile) (op)
+In range of |[Has benchmark profile](#hasProfile) (op)
[Uses benchmark profile](#usesProfile) (op)
[Is subset of profile](#isSubsetOfProfile) (op)
[Is superset of profile](#isSupersetOfProfile) (op)
### Quoted triple count statistics
Property | Value
@@ -277,7 +284,7 @@ Property | Value
--- | ---
URI | `https://w3id.org/riverbench/schema/metadata#Statistics`
Description | Class for statistics objects about distributions
-Sub-classes |[Graph count statistics](#GraphCountStatistics) (c)
[Subject count statistics](#SubjectCountStatistics) (c)
[Object count statistics](#ObjectCountStatistics) (c)
[ASCII control character count statistics](#AsciiControlCharacterCountStatistics) (c)
[Language string count statistics](#LanguageLiteralCountStatistics) (c)
[Predicate count statistics](#PredicateCountStatistics) (c)
[Simple literal count statistics](#SimpleLiteralCountStatistics) (c)
[Statement count statistics](#StatementCountStatistics) (c)
[Blank node count statistics](#BlankNodeCountStatistics) (c)
[Datatype literal count statistics](#DatatypeLiteralCountStatistics) (c)
[IRI count statistics](#IriCountStatistics) (c)
[Datatype count statistics](#DatatypeCountStatistics) (c)
[Literal count statistics](#LiteralCountStatistics) (c)
[Quoted triple count statistics](#QuotedTripleCountStatistics) (c)
+Sub-classes |[Object count statistics](#ObjectCountStatistics) (c)
[ASCII control character count statistics](#AsciiControlCharacterCountStatistics) (c)
[IRI count statistics](#IriCountStatistics) (c)
[Bytes per triple (byte density) statistics](#ByteDensityStatistics) (c)
[Predicate count statistics](#PredicateCountStatistics) (c)
[Graph count statistics](#GraphCountStatistics) (c)
[Literal count statistics](#LiteralCountStatistics) (c)
[Statement count statistics](#StatementCountStatistics) (c)
[Blank node count statistics](#BlankNodeCountStatistics) (c)
[Quoted triple count statistics](#QuotedTripleCountStatistics) (c)
[Datatype literal count statistics](#DatatypeLiteralCountStatistics) (c)
[Subject count statistics](#SubjectCountStatistics) (c)
[Language string count statistics](#LanguageLiteralCountStatistics) (c)
[Simple literal count statistics](#SimpleLiteralCountStatistics) (c)
[Datatype count statistics](#DatatypeCountStatistics) (c)
In domain of |[Statistical property](#statisticalProperty) (dp)
In range of |[Has statistics](#hasStatistics) (op)
@@ -294,7 +301,7 @@ Property | Value
--- | ---
URI | `https://w3id.org/riverbench/schema/metadata#StreamElementSplit`
Description | Describes how was the stream split into individual elements.
-Sub-classes |[Stream elements split by time](#TimeStreamElementSplit) (c)
[Stream elements split by statement count](#StatementCountStreamElementSplit) (c)
[Stream elements split by topic](#TopicStreamElementSplit) (c)
+Sub-classes |[Stream elements split by statement count](#StatementCountStreamElementSplit) (c)
[Stream elements split by time](#TimeStreamElementSplit) (c)
[Stream elements split by topic](#TopicStreamElementSplit) (c)
In range of |[Has stream element split](#hasStreamElementSplit) (op)
### Subject count statistics
@@ -309,7 +316,7 @@ Property | Value
--- | ---
URI | `https://w3id.org/riverbench/schema/metadata#SystemUnderTest`
Description | A system that is tested in a benchmark (for example, an RDF store). Instances of this class should at least have a label (rdfs:label) and a version tag (rb:hasVersion).
-Super-classes |[dcat:Resource](http://www.w3.org/ns/dcat#Resource) (c)
[irao:System](http://ontology.ethereal.cz/irao/System) (c)
+Super-classes |[irao:System](http://ontology.ethereal.cz/irao/System) (c)
[dcat:Resource](http://www.w3.org/ns/dcat#Resource) (c)
In range of |[Uses system under test](#usesSystemUnderTest) (op)
### Benchmark task
@@ -317,7 +324,7 @@ Property | Value
--- | ---
URI | `https://w3id.org/riverbench/schema/metadata#Task`
Description | Class for specific benchmark tasks (e.g., end-to-end streaming latency). Each task belongs to one benchmark category (rb:Category).
-Super-classes |[Member of a benchmark category](#CategoryMember) (c)
[irao:Methodology](http://ontology.ethereal.cz/irao/Methodology) (c)
+Super-classes |[irao:Methodology](http://ontology.ethereal.cz/irao/Methodology) (c)
[Member of a benchmark category](#CategoryMember) (c)
In range of |[Uses benchmark task](#usesTask) (op)
[Has benchmark task](#hasTask) (op)
### Stream elements split by time