Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/ontology improvement #324

Merged
merged 5 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Welcome! OKP4 is a public PoS layer 1 blockchain built for trust-minimized data
</div>
<div class="col">
<div class="card card-body h-100 d-flex flex-column">
<a href="/technical-documentation/introduction" class="card-title card-link stretched-link">
<a href="/technical-documentation/overview" class="card-title card-link stretched-link">
<h2>Technical Documentation</h2>
</a>
<p class="card-text">Deep dive into the OKP4 Protocol.</p>
Expand Down
7 changes: 0 additions & 7 deletions docs/technical-documentation/introduction.md

This file was deleted.

249 changes: 0 additions & 249 deletions docs/technical-documentation/ontology/general-principles.md

This file was deleted.

102 changes: 102 additions & 0 deletions docs/technical-documentation/ontology/okp4-ontology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
sidebar_position: 3
---

# OKP4 Ontology

The OKP4 protocol orchestrates the various resources of the Dataverse (datasets and services) using different blockchain elements such as smart contracts, logic modules, and ontology. All these elements allow for fine management of dataset and service workflows for knowledge creation within a Zone with personalized governance. As seen previous sections, the ontology must stand for the different concepts of the protocol, their relationships, and their properties.

## The big picture

The following diagram depicts the introduced concepts and their relationship with the already existing concepts of the ontology.

```mermaid
classDiagram
Dataset --> Service : providedBy

class Metadata{
<<abstract>>
}
Metadata <|.. ServiceGeneralMetadata
Metadata <|.. DatasetGeneralMetadata
Metadata <|.. ServiceExecutionMetadata
Metadata <|.. ServiceSpecificationMetadata

ServiceExecutionMetadata ..> ServiceExecution : describes

ServiceGeneralMetadata ..> Service : describes
ServiceSpecificationMetadata ..> Service : describes
DatasetGeneralMetadata ..> Dataset : describes

ServiceExecutionOrder --> Service : hasObject
ServiceExecutionOrder --> Service : has contractor

ServiceExecution --> ServiceExecutionOrder : specifiedBy

ServiceExecution --> Service : hasObject
ServiceExecution --> ServiceExecution : hasParent

ServiceExecution --> Dataset : hasInput
ServiceExecution --> Dataset : produces
ServiceExecution --> Metadata : produces
```

## Class and properties

The following concepts and properties are found within the OKP4 ontology:

### Data

This refers to the data contained within a dataset.

### Dataset

- hasIdentifier

This is a dataset made available by a user on the protocol.

### DatasetGeneralMetadata

- hasTag
- hasCreator
- hasDescription
- hasPublisher
- hasTitle
- hasSpatialCoverage
- hasTemporalCoverage
- hasImage

This is the description of a given dataset in metadata form.

### Zone

Zone is a conceptual framework that is established based on a set of rules, within which recognized `Resources` must conform, considering associated consents.

Zones are described by a set of metadata providing information about various aspects of the Zone, such as the zone's name, general information about the provider, and more.

Specific data description vocabularies and thesauri are used to structure this metadata. A dedicated metadata profile outlines the rules that govern the Zone, expressing its fundamental principles, intentions, scope, and ultimate objectives. These rules encompass the entities involved and the Resources that interact within the Zone.

They can be customized to address specific use cases, industry sectors, partnership networks, or geographic regions, facilitating tailored governance arrangements within a specific context.

### DIDURI

A decentralized identifier URI. A URI that identifies a subject in a decentralized system and is managed independently of any centralized registry.

### Metadata

The information data about something (i.e. data about the data). This something can be a Zone, a Dataset, a Service, or any other entity that can be described.

Metadata is an abstract concept which is refined in Metadata Profiles used to provide a formal specification that defines the set of metadata elements, their semantics, and their syntax to be used in a particular context or application. The OKP4 protocol proposes several profiles at the core of the ontology, such as GeneralMetadata for describing services or datasets.

### Resource

Services or datasets, a resource belongs to the Dataverse.

### Service

- hasIdentifier
A service consumes a resource and produces data.

## Conclusion

With all these concepts, their properties, and their relationships, we can create the OKP4 ontology and explain the workings of the OKP4 protocol in a structured and formalized way. This ontology can be expressed in different formats, both understandable by humans and machines. It can be expressed in French or English, RDF, OWL, JSON-LD, N-Triples, Notation3 RDF/XML, Turtle, etc.
7 changes: 0 additions & 7 deletions docs/technical-documentation/ontology/resources.md

This file was deleted.

Loading