Update README.md

README.md

@@ -52,23 +52,65 @@ For more information see: [ArXiv](https://arxiv.org/abs/2405.18115)
 ## Usage
 
 #### Option 1: HuggingFace
-  For the [All Features Sentences](#all_features_sentences) subset:
+  For the sentences subsets such as [All Features Sentences](#all_features_sentences) subset:
   ```python
   from datasets import load_dataset
-  knesset_corpus = load_dataset("HaifaCLGroup/knessetCorpus", name="all_features_sentences", split='train', streaming=True) #streaming is recommended
-  
+  subset_name = "all_features_sentences" #or "no_morph_all_features_sentences"
+  knesset_corpus = load_dataset("HaifaCLGroup/knessetCorpus", name=subset_name, split='train', streaming=True) #streaming is recommended
+
+  for example in knesset_corpus:
+    speaker_name = example["speaker_name"]
+    sentence_text = example["sentence_text"]
+    gender = example["speaker_gender"]
+    faction = example["current_faction_name"]
+    knesset_num = int(example["knesset_number"])
+    print(f'knesset_number: {knesset_num}, speaker_name: {speaker_name}, sentenece_text: {sentence_text}, speaker_gender: {gender}, faction: {faction}')
   ```
-  For the [Non-Morphological Features Sentences](#non-morphological_features_sentences) subset:
-  * Ideal if morpho-syntactic annotations aren't relevant to your work, providing a less disk space heavy option.
+
+  * The [Non-Morphological Features Sentences](#non-morphological_features_sentences) subset is Ideal if morpho-syntactic annotations aren't relevant to your work, providing a less disk space heavy option.
+
+
+  For the [Protocols](#protocols) subset:
   ```python
   from datasets import load_dataset
-  knesset_corpus = load_dataset("HaifaCLGroup/knessetCorpus", "no_morph_all_features_sentences", split='train', streaming=True)#streaming is recommended
-  
+  subset_name = "protocols"
+  knesset_corpus = load_dataset("HaifaCLGroup/knessetCorpus", name=subset_name, split='train', streaming=True) #streaming is recommended
+
+  for example in knesset_corpus:
+    protocol_name = example["protocol_name"]
+    session_name = example["session_name"]
+    protocol_sentences = example["protocol_sentences"]
+    if isinstance(protocol_sentences, dict):
+        protocol_sentences = [
+            {key: value[i] for key, value in protocol_sentences.items()}
+            for i in range(len(next(iter(protocol_sentences.values()))))
+        ]
+    for sent in protocol_sentences:
+        speaker_name = sent["speaker_name"]
+        text = sent["sentence_text"]
+        print(f'protocol: {protocol_name}, session: {session_name}, speaker: {speaker_name}, text: {text}')
   ```
-  See [Subsets](#subsets) for other subsets options and change the name field accordingly.
+  
+  See [Subsets](#subsets) for other subsets options and change the subset_name field accordingly.
+
+#### Option 2: Directly from files
+ ```python
+import json
 
+path = <path to committee_full_sentences.jsonl> #or any other sentences jsonl file
+with open(path, encoding="utf-8") as file:
+    for line in file:
+        try:
+            sent = json.loads(line)
+        except Exception as e:
+            print(f'couldnt load json line. error:{e}.')
+        sent_id = sent["sentence_id"]
+        sent_text = sent["sentence_text"]
+        speaker_name = sent["speaker_name"]
+        print(f"ID: {sent_id}, speaker name: {speaker_name},  text: {sent_text")
+  ```
 
-#### Option 2: ElasticSearch
+#### Option 3: ElasticSearch
 IP address, username and password for the es server and [Kibana](http://34.0.64.248:5601/):
 
 ##### Credentials for Kibana:
@@ -97,22 +139,7 @@ for hit in resp['hits']['hits']:
     print("id: %(sentence_id)s: speaker_name: %(speaker_name)s: sentence_text: %(sentence_text)s" % hit["_source"])
  ```
 
-#### Option 3: Directly from files
- ```python
-import json
 
-path = <path to committee_full_sentences.jsonl> #or any other sentences jsonl file
-with open(path, encoding="utf-8") as file:
-    for line in file:
-        try:
-            sent = json.loads(line)
-        except Exception as e:
-            print(f'couldnt load json line. error:{e}.')
-        sent_id = sent["sentence_id"]
-        sent_text = sent["sentence_text"]
-        speaker_name = sent["speaker_name"]
-        print(f"ID: {sent_id}, speaker name: {speaker_name},  text: {sent_text")
-  ```
 
 ## Subsets