Skip to content

Commit

Permalink
Automatic update of schema docs (dev)
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 19, 2024
1 parent 3acf5d2 commit 766c20a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/schema/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br />
Has members |[Distributions](#groupDistributions)<br />[General information](#groupGeneralInfo)<br />[Technical metadata](#groupTechnicalMetadata)<br />[Content](#groupContent)<br />
Has members |[Content](#groupContent)<br />[Distributions](#groupDistributions)<br />[Technical metadata](#groupTechnicalMetadata)<br />[General information](#groupGeneralInfo)<br />


## Object Properties
Expand Down
33 changes: 20 additions & 13 deletions docs/schema/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)<br />
Restrictions |[Uses metric](#usesMetric) (dp) **some** [xsd:string](http://www.w3.org/2001/XMLSchema#string) (c)<br />[Uses system under test](#usesSystemUnderTest) (op) **some** [System under test](#SystemUnderTest) (c)<br />[Uses benchmark profile](#usesProfile) (op) **some** [Benchmark profile](#Profile) (c)<br />[Uses benchmark task](#usesTask) (op) **some** [Benchmark task](#Task) (c)<br />
Restrictions |[Uses benchmark task](#usesTask) (op) **some** [Benchmark task](#Task) (c)<br />[Uses system under test](#usesSystemUnderTest) (op) **some** [System under test](#SystemUnderTest) (c)<br />[Uses metric](#usesMetric) (dp) **some** [xsd:string](http://www.w3.org/2001/XMLSchema#string) (c)<br />[Uses benchmark profile](#usesProfile) (op) **some** [Benchmark profile](#Profile) (c)<br />

### Blank node count statistics <a name="BlankNodeCountStatistics"></a>
Property | Value
Expand All @@ -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)<br />

### Bytes per triple (byte density) statistics <a name="ByteDensityStatistics"></a>
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)<br />

### Benchmark category <a name="Category"></a>
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)<br />
In domain of |[Has category member](#hasCategoryMember) (op)<br />[Has benchmark task](#hasTask) (op)<br />[Has benchmark profile](#hasProfile) (op)<br />
In range of |[In benchmark category](#inCategory) (fp)<br />[Has benchmark category](#hasCategory) (op)<br />
In domain of |[Has benchmark task](#hasTask) (op)<br />[Has benchmark profile](#hasProfile) (op)<br />[Has category member](#hasCategoryMember) (op)<br />
In range of |[Has benchmark category](#hasCategory) (op)<br />[In benchmark category](#inCategory) (fp)<br />

### Member of a benchmark category <a name="CategoryMember"></a>
Property | Value
Expand Down Expand Up @@ -167,15 +174,15 @@ 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)<br />
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)<br />
In domain of |[Has statistics set](#hasStatisticsSet) (op)<br />[Has distribution type](#hasDistributionType) (op)<br />[Has file name](#hasFileName) (dp)<br />
In domain of |[Has file name](#hasFileName) (dp)<br />[Has distribution type](#hasDistributionType) (op)<br />[Has statistics set](#hasStatisticsSet) (op)<br />

### RiverBench distribution type <a name="DistributionType"></a>
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)<br />
Has members |[Jelly distribution](#jellyDistribution)<br />[Full distribution](#fullDistribution)<br />[Partial distribution](#partialDistribution)<br />[Stream distribution](#streamDistribution)<br />[Flat distribution](#flatDistribution)<br />
Has members |[Flat distribution](#flatDistribution)<br />[Full distribution](#fullDistribution)<br />[Stream distribution](#streamDistribution)<br />[Jelly distribution](#jellyDistribution)<br />[Partial distribution](#partialDistribution)<br />

### Graph count statistics <a name="GraphCountStatistics"></a>
Property | Value
Expand Down Expand Up @@ -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)<br />[Dataset series](#DatasetSeries) (c)<br />
In domain of |[Has distribution shape](#hasDistributionShape) (op)<br />[Is superset of profile](#isSupersetOfProfile) (op)<br />[Has dataset shape](#hasDatasetShape) (op)<br />[Is subset of profile](#isSubsetOfProfile) (op)<br />
In range of |[Has benchmark profile](#hasProfile) (op)<br />[Uses benchmark profile](#usesProfile) (op)<br />[Is superset of profile](#isSupersetOfProfile) (op)<br />[Is subset of profile](#isSubsetOfProfile) (op)<br />
In domain of |[Is superset of profile](#isSupersetOfProfile) (op)<br />[Has distribution shape](#hasDistributionShape) (op)<br />[Has dataset shape](#hasDatasetShape) (op)<br />[Is subset of profile](#isSubsetOfProfile) (op)<br />
In range of |[Has benchmark profile](#hasProfile) (op)<br />[Uses benchmark profile](#usesProfile) (op)<br />[Is subset of profile](#isSubsetOfProfile) (op)<br />[Is superset of profile](#isSupersetOfProfile) (op)<br />

### Quoted triple count statistics <a name="QuotedTripleCountStatistics"></a>
Property | Value
Expand Down Expand Up @@ -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)<br />[Subject count statistics](#SubjectCountStatistics) (c)<br />[Object count statistics](#ObjectCountStatistics) (c)<br />[ASCII control character count statistics](#AsciiControlCharacterCountStatistics) (c)<br />[Language string count statistics](#LanguageLiteralCountStatistics) (c)<br />[Predicate count statistics](#PredicateCountStatistics) (c)<br />[Simple literal count statistics](#SimpleLiteralCountStatistics) (c)<br />[Statement count statistics](#StatementCountStatistics) (c)<br />[Blank node count statistics](#BlankNodeCountStatistics) (c)<br />[Datatype literal count statistics](#DatatypeLiteralCountStatistics) (c)<br />[IRI count statistics](#IriCountStatistics) (c)<br />[Datatype count statistics](#DatatypeCountStatistics) (c)<br />[Literal count statistics](#LiteralCountStatistics) (c)<br />[Quoted triple count statistics](#QuotedTripleCountStatistics) (c)<br />
Sub-classes |[Object count statistics](#ObjectCountStatistics) (c)<br />[ASCII control character count statistics](#AsciiControlCharacterCountStatistics) (c)<br />[IRI count statistics](#IriCountStatistics) (c)<br />[Bytes per triple (byte density) statistics](#ByteDensityStatistics) (c)<br />[Predicate count statistics](#PredicateCountStatistics) (c)<br />[Graph count statistics](#GraphCountStatistics) (c)<br />[Literal count statistics](#LiteralCountStatistics) (c)<br />[Statement count statistics](#StatementCountStatistics) (c)<br />[Blank node count statistics](#BlankNodeCountStatistics) (c)<br />[Quoted triple count statistics](#QuotedTripleCountStatistics) (c)<br />[Datatype literal count statistics](#DatatypeLiteralCountStatistics) (c)<br />[Subject count statistics](#SubjectCountStatistics) (c)<br />[Language string count statistics](#LanguageLiteralCountStatistics) (c)<br />[Simple literal count statistics](#SimpleLiteralCountStatistics) (c)<br />[Datatype count statistics](#DatatypeCountStatistics) (c)<br />
In domain of |[Statistical property](#statisticalProperty) (dp)<br />
In range of |[Has statistics](#hasStatistics) (op)<br />

Expand All @@ -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)<br />[Stream elements split by statement count](#StatementCountStreamElementSplit) (c)<br />[Stream elements split by topic](#TopicStreamElementSplit) (c)<br />
Sub-classes |[Stream elements split by statement count](#StatementCountStreamElementSplit) (c)<br />[Stream elements split by time](#TimeStreamElementSplit) (c)<br />[Stream elements split by topic](#TopicStreamElementSplit) (c)<br />
In range of |[Has stream element split](#hasStreamElementSplit) (op)<br />

### Subject count statistics <a name="SubjectCountStatistics"></a>
Expand All @@ -309,15 +316,15 @@ 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)<br />[irao:System](http://ontology.ethereal.cz/irao/System) (c)<br />
Super-classes |[irao:System](http://ontology.ethereal.cz/irao/System) (c)<br />[dcat:Resource](http://www.w3.org/ns/dcat#Resource) (c)<br />
In range of |[Uses system under test](#usesSystemUnderTest) (op)<br />

### Benchmark task <a name="Task"></a>
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)<br />[irao:Methodology](http://ontology.ethereal.cz/irao/Methodology) (c)<br />
Super-classes |[irao:Methodology](http://ontology.ethereal.cz/irao/Methodology) (c)<br />[Member of a benchmark category](#CategoryMember) (c)<br />
In range of |[Uses benchmark task](#usesTask) (op)<br />[Has benchmark task](#hasTask) (op)<br />

### Stream elements split by time <a name="TimeStreamElementSplit"></a>
Expand Down

0 comments on commit 766c20a

Please sign in to comment.