Skip to content

Commit 7b47629

Browse files
committed
Merge branch 'master' of github.com:HumanBrainProject/fairgraph
# Conflicts: # doc/contributing.rst
2 parents 1027b30 + 62e3203 commit 7b47629

601 files changed

Lines changed: 30122 additions & 532 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,34 @@ pip install -U ./fairgraph
3030
## Knowledge Graph and openMINDS versions
3131

3232
This version of fairgraph supports version 3 of the EBRAINS Knowledge Graph (KG),
33-
and version 4 of the openMINDS metadata schemas.
33+
and both version 4 and version 5 of the openMINDS metadata schemas.
34+
35+
openMINDS v4 is the default: `fairgraph.openminds.core` and the other domain modules
36+
contain the v4 classes, as before. The v5 classes live alongside them, and each version
37+
can also be imported explicitly:
38+
39+
```python
40+
import fairgraph.openminds.core as omcore # v4 (default)
41+
import fairgraph.openminds.v4.core as omcore4 # explicit v4
42+
import fairgraph.openminds.v5.core as omcore5 # explicit v5
43+
```
44+
45+
Since the two versions share the same node type URIs in the KG, the client needs to be told
46+
which of them to deserialize responses into:
47+
48+
```python
49+
client = KGClient(host=host_serving_v5_metadata, openminds_version="v5")
50+
```
51+
52+
Omitting `openminds_version` keeps the v4 behaviour.
53+
54+
> [!IMPORTANT]
55+
> **openMINDS v5 support is experimental.** The migration of the KG to openMINDS v5 is still in
56+
> progress, and the production and pre-production deployments serve v4, so the v5 classes have
57+
> not yet been exercised against a fully populated Knowledge Graph. Until that changes, v5
58+
> support may be altered in backwards-incompatible ways in any release, without the deprecation
59+
> period that applies to the rest of the API. openMINDS v4 support is unaffected and remains the
60+
> default. Reports of problems with v5 are very welcome.
3461
3562
## Basic setup
3663

0 commit comments

Comments
 (0)