Improvements in the docs , updated dependencies (#33)

Auto-Playground · Mar 24, 2024 · d79acef · d79acef
2 parents d5c3b7f + 86cc0d2
commit d79acef
Show file tree

Hide file tree

Showing 6 changed files with 133 additions and 132 deletions.
diff --git a/README.md b/README.md
@@ -69,7 +69,7 @@ from ragrank.metric import response_relevancy
 data = from_dict({
     "question": "What is the capital of France?",
     "context": ["France is famous for its iconic landmarks such as the Eiffel Tower and its rich culinary tradition."],
-    "answer": "The capital of France is Paris.",
+    "response": "The capital of France is Paris.",
 })
 
 # Evaluate the response relevance metric

diff --git a/docs/docs/conf.py b/docs/docs/conf.py
@@ -6,7 +6,7 @@
 
 # -- Project information --------
 
-project = "ragrank"
+project = "Ragrank"
 copyright = "2024, Izam Mohammed"
 author = "Izam Mohammed"
 release = "0.0.6"
@@ -45,7 +45,7 @@
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 html_theme = "furo"
-html_title = "ragrank 🎯"
+html_title = "ragrank"
 html_favicon = "./_static/favicon.ico"
 html_static_path = ["_static"]
 language = "en"

diff --git a/docs/docs/evaluation/detailed_evaluation.md b/docs/docs/evaluation/detailed_evaluation.md
@@ -23,7 +23,7 @@ data = from_dict(
         "context": [
             "France is famous for its iconic landmarks such as the Eiffel Tower and its rich culinary tradition."
         ],
-        "answer": "The capital of France is Paris.",
+        "response": "The capital of France is Paris.",
     },
     return_as_dataset=True,
 )

diff --git a/docs/docs/get_started/basic_evaluation.md b/docs/docs/get_started/basic_evaluation.md
@@ -25,7 +25,7 @@ from ragrank.metric import response_relevancy
 data = from_dict({
     "question": "What is the capital of France?",
     "context": ["France is famous for its iconic landmarks such as the Eiffel Tower and its rich culinary tradition."],
-    "answer": "The capital of France is Paris.",
+    "response": "The capital of France is Paris.",
 })
 
 # Evaluate the response relevance metric