Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/TharinduDR/TransQuest.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTharinduDR <rhtdranasinghe@gmail.com>2020-10-12 21:26:08 +0300
committerTharinduDR <rhtdranasinghe@gmail.com>2020-10-12 21:26:08 +0300
commit43ab55bbb16ef9b825aef4cf337aa4c4cf1a82e0 (patch)
tree7cbe9d5dc4da0dc901a55f8102883d7e0ea2675f /docs
parent1f883f0a7bd3714d14f8db41ac930408c026a245 (diff)
033: Adding documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/examples.md8
-rw-r--r--docs/pretrained.md10
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/examples.md b/docs/examples.md
index e69de29..e3069a5 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -0,0 +1,8 @@
+# Examples
+We have provided several examples on how to use TransQuest in recent WMT sentence-level quality estimation shared tasks. They are included in the repository but are not shipped with the library. Therefore, if you need to run the examples, please clone the repository.
+
+```bash
+git clone https://github.com/TharinduDR/TransQuest.git
+cd TransQuest
+pip install -r requirements.txt
+``` \ No newline at end of file
diff --git a/docs/pretrained.md b/docs/pretrained.md
index e69de29..00fd964 100644
--- a/docs/pretrained.md
+++ b/docs/pretrained.md
@@ -0,0 +1,10 @@
+# Pre-trained Models
+We have released several pre-trained TransQuest models on two aspects in sentence-level quality estimation. We will be keep releasing new models. So please keep in touch.
+
+## Predicting HTER
+
+### Available Models
+
+## Predicting Direct Assessment
+
+### Available Models \ No newline at end of file