wikipunk commited on
Commit
71db492
1 Parent(s): 7b5a60c

add explicit docs on the features using an example

Browse files
Files changed (1) hide show
  1. README.md +33 -5
README.md CHANGED
@@ -87,11 +87,6 @@ fine-tune existing models or build new ones.
87
  compressed artifact is downloaded and extracted by the Hugging Face
88
  datasets library to yield the examples in the dataset.
89
 
90
- ## Features
91
- The FIBO dataset is composed of triples representing the relationships
92
- between different financial concepts and named individuals such as
93
- market participants, corporations, and contractual agents.
94
-
95
  ### Usage
96
  First make sure you have the requirements installed:
97
 
@@ -107,11 +102,44 @@ from datasets import load_dataset
107
  dataset = load_dataset('wikipunk/fibo2023Q3', split='train')
108
  ```
109
 
 
 
 
 
 
110
  #### Note on Format:
111
  The subject, predicate, and object features are stored in N3 notation
112
  with no prefix mappings. This allows users to parse each component
113
  using `rdflib.util.from_n3` from the RDFLib Python library.
114
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
115
  ### Example
116
  Here is an example of a triple in the dataset:
117
  - Subject: `"<https://spec.edmcouncil.org/fibo/ontology/FBC/FunctionalEntities/MarketsIndividuals/ServiceProvider-L-JEUVK5RWVJEN8W0C9M24>"`
 
87
  compressed artifact is downloaded and extracted by the Hugging Face
88
  datasets library to yield the examples in the dataset.
89
 
 
 
 
 
 
90
  ### Usage
91
  First make sure you have the requirements installed:
92
 
 
102
  dataset = load_dataset('wikipunk/fibo2023Q3', split='train')
103
  ```
104
 
105
+ ## Features
106
+ The FIBO dataset is composed of triples representing the relationships
107
+ between different financial concepts and named individuals such as
108
+ market participants, corporations, and contractual agents.
109
+
110
  #### Note on Format:
111
  The subject, predicate, and object features are stored in N3 notation
112
  with no prefix mappings. This allows users to parse each component
113
  using `rdflib.util.from_n3` from the RDFLib Python library.
114
 
115
+ ### 1. **Subject** (`string`)
116
+ The subject of a triple is the primary entity or focus of the statement. In this dataset, the subject often represents a specific financial instrument or entity. For instance:
117
+ `<https://spec.edmcouncil.org/fibo/ontology/SEC/Equities/EquitiesExampleIndividuals/XNYSListedTheCoca-ColaCompanyCommonStock>`
118
+ refers to the common stock of The Coca-Cola Company that is listed on
119
+ the NYSE.
120
+
121
+ ### 2. **Predicate** (`string`)
122
+ The predicate of a triple indicates the nature of the relationship between the subject and the object. It describes a specific property, characteristic, or connection of the subject. In our example:
123
+ `<https://spec.edmcouncil.org/fibo/ontology/SEC/Securities/SecuritiesListings/isTradedOn>`
124
+ signifies that the financial instrument (subject) is traded on a
125
+ particular exchange (object).
126
+
127
+ ### 3. **Object** (`string`)
128
+ The object of a triple is the entity or value that is associated with the subject via the predicate. It can be another financial concept, a trading platform, or any other related entity. In the context of our example:
129
+ `<https://spec.edmcouncil.org/fibo/ontology/FBC/FunctionalEntities/NorthAmericanEntities/USMarketsAndExchangesIndividuals/NewYorkStockExchange>`
130
+ represents the New York Stock Exchange where the aforementioned
131
+ Coca-Cola common stock is traded.
132
+
133
+ #### Note:
134
+ The dataset contains example individuals from the ontology as
135
+ reference points. These examples provide a structured framework for
136
+ understanding the relationships and entities within the financial
137
+ domain. However, the individuals included are not exhaustive. With
138
+ advancements in Large Language Models, especially Retrieval Augmented
139
+ Generation (RAG), there's potential to generate and expand upon these
140
+ examples, enriching the dataset with more structured data and
141
+ insights.
142
+
143
  ### Example
144
  Here is an example of a triple in the dataset:
145
  - Subject: `"<https://spec.edmcouncil.org/fibo/ontology/FBC/FunctionalEntities/MarketsIndividuals/ServiceProvider-L-JEUVK5RWVJEN8W0C9M24>"`