update readme

.gitattributes

@@ -53,3 +53,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text
 *.webp filter=lfs diff=lfs merge=lfs -text
+raw/yago-taxonomy.ttl filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,99 @@
----
-license: isc
----
+# YAGO 4.5 Dataset (English subset for LLM fine-tuning)
+
+## Dataset Description
+This datasets contains triples filtered from yago-facts.ttl and
+yago-beyond-wikipedia.ttl in the YAGO 4.5 dataset. The SPARQL query
+used to filter the triples is in `raw/filter.sparql`. This represents
+a subset of the YAGO 4.5 dataset maintaining only English labels. 
+
+I remapped some schema.org URIs to use the
+`http://yago-knowledge.org/resource/` which were not present in the
+schema.org vocabulary.  I also removed schema:sameAs and owl:sameAs
+relations from this dataset, as well as triples with xsd:anyURI object
+literals, as my goal is to use this dataset for fine-tuning a large
+language model for knowledge graph completion and I do not want
+to train the base model to predict these kind of relations.
+
+### Overview
+
+YAGO 4.5 is the latest version of the YAGO knowledge base. It is
+based on Wikidata — the largest public general-purpose knowledge
+base. YAGO refines the data as follows:
+
+* All entity identifiers and property identifiers are human-readable.
+* The top-level classes come from schema.org — a standard repertoire
+  of classes and properties maintained by Google and others. The lower
+  level classes are a careful selection of the Wikidata taxonomy.
+* The properties come from schema.org.
+* YAGO 4.5 contains semantic constraints in the form of SHACL. These
+  constraints keep the data clean, and allow for logical reasoning on
+  YAGO. 
+
+
+### Dataset Structure
+The dataset is structured as follows:
+
+- **raw/yago-taxonomy.ttl:** Contains the `rdfs:subClassOf` relations
+  for YAGO and the prefix mappings for the N-Triples.
+- **raw/facts.tar.gz:** Compressed file containing chunks of the
+  dataset in N-Triples format, representing the factual knowledge in
+  YAGO. 
+
+### Features
+
+Each RDF triple in the dataset is represented with the following features:
+
+- **subject:** The subject of the triple, representing the entity.
+- **predicate:** The predicate of the triple, representing the
+  relationship between the subject and object.
+- **object:** The object of the triple, representing the entity or
+  value linked by the predicate.
+
+### Splits
+
+The dataset is logically divided into multiple chunks, each containing
+a subset of RDF triples. Users can load specific chunks or the entire
+dataset based on their requirements.
+
+## Usage
+
+### Loading the Dataset
+
+The dataset can be loaded using the Hugging Face `datasets` library as follows:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset('wikipunk/yago-4.5-en', num_proc=4)
+```
+
+### Accessing the YAGO Taxonomy File
+
+The `yago-taxonomy.ttl` file can be accessed and loaded in every process as follows:
+
+```python
+from rdflib import Graph
+
+taxonomy_graph = Graph()
+taxonomy_graph.parse('raw/yago-taxonomy.ttl', format='turtle') 
+```
+
+## Additional Information
+
+### Licensing
+
+The YAGO 4.5 dataset is available under the [Creative Commons Attribution-ShareAlike 3.0 license](https://creativecommons.org/licenses/by-sa/3.0/).
+
+### Citation
+
+If you use the YAGO 4.5 dataset in your work, please cite the
+following publication:
+
+```bibtex
+@article{suchanek2023integrating,
+  title={Integrating the Wikidata Taxonomy into YAGO},
+  author={Suchanek, Fabian M and Alam, Mehwish and Bonald, Thomas and Paris, Pierre-Henri and Soria, Jules},
+  journal={arXiv preprint arXiv:2308.11884},
+  year={2023}
+}
+```

raw/filter.sparql

@@ -0,0 +1,90 @@
+PREFIX yago: <http://yago-knowledge.org/resource/>
+PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
+PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
+PREFIX ontolex: <http://www.w3.org/ns/lemon/ontolex#>
+PREFIX dct: <http://purl.org/dc/terms/>
+PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+PREFIX owl: <http://www.w3.org/2002/07/owl#>
+PREFIX wikibase: <http://wikiba.se/ontology#>
+PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
+PREFIX schema: <http://schema.org/>
+PREFIX cc: <http://creativecommons.org/ns#>
+PREFIX geo: <http://www.opengis.net/ont/geosparql#>
+PREFIX prov: <http://www.w3.org/ns/prov#>
+PREFIX wd: <http://www.wikidata.org/entity/>
+PREFIX data: <https://www.wikidata.org/wiki/Special:EntityData/>
+PREFIX sh: <http://www.w3.org/ns/shacl#>
+PREFIX s: <http://www.wikidata.org/entity/statement/>
+PREFIX ref: <http://www.wikidata.org/reference/>
+PREFIX v: <http://www.wikidata.org/value/>
+PREFIX wdt: <http://www.wikidata.org/prop/direct/>
+PREFIX wpq: <http://www.wikidata.org/prop/quant/>
+PREFIX wdtn: <http://www.wikidata.org/prop/direct-normalized/>
+PREFIX p: <http://www.wikidata.org/prop/>
+PREFIX ps: <http://www.wikidata.org/prop/statement/>
+PREFIX psv: <http://www.wikidata.org/prop/statement/value/>
+PREFIX psn: <http://www.wikidata.org/prop/statement/value-normalized/>
+PREFIX pq: <http://www.wikidata.org/prop/qualifier/>
+PREFIX pqv: <http://www.wikidata.org/prop/qualifier/value/>
+PREFIX pqn: <http://www.wikidata.org/prop/qualifier/value-normalized/>
+PREFIX pr: <http://www.wikidata.org/prop/reference/>
+PREFIX prv: <http://www.wikidata.org/prop/reference/value/>
+PREFIX prn: <http://www.wikidata.org/prop/reference/value-normalized/>
+PREFIX wdno: <http://www.wikidata.org/prop/novalue/>
+PREFIX ys: <http://yago-knowledge.org/schema#>
+
+CONSTRUCT {
+  ?s ?newp ?o .
+}
+WHERE {
+  ?s ?p ?originalO .
+  
+  # Transforming the predicates to a new namespace where applicable
+  BIND(
+       IF(?p IN (
+		 schema:administrates,
+		 schema:demonym,
+		 schema:highestPoint,
+		 schema:humanDevelopmentIndex,
+		 schema:influencedBy,
+		 schema:leader,
+		 schema:lowestPoint,
+		 schema:motto,
+		 schema:neighbors,
+		 schema:officialLanguage,
+		 schema:ownedBy,
+		 schema:populationNumber,
+		 schema:unemploymentRate
+		 ), URI(REPLACE(STR(?p), "http://schema.org/", "http://yago-knowledge.org/resource/")), ?p)
+       AS ?newp
+       )
+
+  # Transforming negative xsd:dateTime to xsd:dateTimeStamp
+  BIND(
+       IF(datatype(?originalO) = xsd:dateTime && STRSTARTS(STR(?originalO), "-"),
+	  STRDT(STR(?originalO), xsd:dateTimeStamp),
+	  ?originalO)
+       AS ?o
+       )
+  
+  # Filtering out non-English literals and xsd:anyURI literals
+  FILTER (
+	  !(
+	    isLiteral(?o) && 
+	    (
+	     lang(?o) != "" && 
+	     !(
+               langMatches(lang(?o), "en") && 
+               lang(?o) != "en-gb" && 
+               lang(?o) != "en-ca"
+	       ) || 
+	     datatype(?o) = xsd:anyURI || 
+	     (?p = rdfs:label && str(?o) = "Generic instance")
+	     )
+	    )
+	  )
+
+  # Excluding specific predicates
+  FILTER (?p != schema:sameAs)
+  FILTER (?p != owl:sameAs)
+}

raw/yago-taxonomy.ttl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5515105ca9d414968aa53046428b16203577f00b24795fbce1b3deba7c3bfd8a
+size 13200375