Update README.md

README.md

@@ -22,6 +22,45 @@ configs:
 
 The widespread availability of scientific documents in multiple languages, coupled with the development of automatic translation and editing tools, has created a demand for efficient methods that can detect plagiarism across different languages.
 
+# Usage of Dataset
+
+## Load Data
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("AntiplagiatCompany/CL4Lang")
+```
+
+## Create Index of collection
+
+```python
+# The list consists of dictionaries with document id, text of the document and text language information (also present xml data, but it used only for querys, not for indexing)
+collection = ds['index'].to_list()
+
+# The list of object can be indexing by using different methods (vector search methods or classical BM25 indexing methods)
+index = make_index(collection)
+```
+
+## Evaluate The Query Result
+
+```python
+# The list consists of dictionaries with document id, text of the document, text language information, and XML information about text reuses in query from collection.
+queries = ds['query'].to_list()
+
+real, predict = [], []
+for query in queries:
+    real.append(query['xml'])
+    predict.append(
+        convert_answer_to_xml(
+            index.search(text=query['text'], lang=query['lang'])
+        )
+    )
+
+# More information about the XML markup description and evaluation see http://pan.webis.de/clef13/pan13-web/plagiarism-detection.html
+evaluate_system(real, predict)
+```
+
 # Citation
 
 If you use that results in your research, please cite our paper: