Update README.md

README.md

@@ -45,12 +45,23 @@ The dataset is a json lines file with each line corresponding to a single docume
 
 ### Data Fields
 The file contains the following fields: 
-- case_id  -  running number for cases 
-- Id - 
-- CaseId - 
+- case_id  -  running number for cases
+- download_time - when the document was downloaded (datetime)
+- number_of_case_documents - number of documents in the current case
+- file_name - full name of the document file, including relative path
+- Id - document id
+- CaseId - case id
+- VerdictDt - Date of the document (datetime)
+- CreatedDate - Date of when the document was inserted into the Supreme Court database
+- CaseNum - case number
+- CaseDesc - Unique case identifier. This id is used to reference cases within the Israeli legal system
+- Pages - number of pages in the original document
+- Path - relative path to the document
 - CaseName -  formal name of the case
-- Year -
-- TypeCode - enumeration of the type 
+- FileName - document file name, without path
+- DocName -document file name, without path
+- Year - document creation year
+- TypeCode - enumeration of document types (see Type field below)
 - Type - Document type
   - פסק-דין	84339
   - החלטה	663099
@@ -60,24 +71,45 @@ The file contains the following fields:
   - צו	2606
   - פד"י	302
   - תקצירים	316
-- SeqNum - 
-- document_hash -  unique document identifier 
-- html_text - clean document text. The original layout (paragraphs,lists, etc.) is preserved.   
-- html_title -  document title extracted from HTML
-
-[More Information Needed]
+- Technical - boolean indicator of whether the document is technical or not.
+- CodeVolume - ?
+- document_hash - 258-bit hashtag of the document name. Used internally to uniquely identify the document
+- text - text of the document. Multiple newlines and other document formating elements (paragraphs,lists, etc.) are preserved.
+- html_title -  document title extracted from the HTML
+- VerdictsDt -  date of the verdict
+- meta_case_nm - formal case name, 
+- meta_sec_appeal - integer or None
+- meta_side_ty - case type, list of strings
+- meta_verdict_file_nm - name of the verdict file
+- meta_judge - list of names of the cases judges 
+- meta_mador_nm - name of the court instance (e.g. בג"ץ)
+- meta_side_nm - list of the case parties, list of strings
+- meta_verdict_dt - date of the verdict
+- meta_case_dt - date of the case 
+- meta_verdict_nbr - 
+- meta_ProgId - name of the software used to create the document (None, Word, etc)
+- meta_is_technical - whether the document is technical, {'false', 'true'}
+- meta_judge_nm_last - last names of the judges (list of strings)
+- meta_case_nbr - formal number of the case (same as CaseDesc)
+- meta_verdict_ty - type of the decision (same as Type)
+- meta_lawyer_nm - list of lawyer names, list of strings or None
+- meta_judge_nm_first - list of judges' first names, list of strings
+- meta_verdict_pages - number of document cases
+- meta_inyan_nm - court בג"ץ 
+- meta_court_nm - court (e.g. בית המשפט העליון )
 
 ### Data Splits
-
-[More Information Needed]
+The entire dataset is qualified as 'train'.
 
 ## Dataset Creation
+2023-04-22
 
 ### Curation Rationale
 
 [More Information Needed]
 
 ### Source Data
+https://supreme.court.gov.il/
 
 #### Initial Data Collection and Normalization
 The data was colleted by crawling the Israeli Supreme Court website.
@@ -97,8 +129,7 @@ The data was colleted by crawling the Israeli Supreme Court website.
 [More Information Needed]
 
 ### Personal and Sensitive Information
-
-[More Information Needed]
+The data contained in this dataset is public. 
 
 ## Considerations for Using the Data
 
@@ -117,17 +148,16 @@ The data was colleted by crawling the Israeli Supreme Court website.
 ## Additional Information
 
 ### Dataset Curators
-
-[More Information Needed]
+Prof. Lev Muchnik, Hebrew University of Jerusalem
+Dr. Inbal Yahav Shenberger, Tel Aviv University
 
 ### Licensing Information
 
 [More Information Needed]
 
 ### Citation Information
+Lev Muchnik, Inbal Yahav, Ariel Nevo, Avichay Chriqui, Tim Shektov, 2023, The Israli Supreme Court Dataset
 
-[More Information Needed]
 
 ### Contributions
-
-[More Information Needed]
+The authours would like to thank the Israeli Innovation Authority (grants #01103653 and #01103654) for their support in creating of this dataset.