Version change (#39)

README.md

@@ -30,7 +30,7 @@
         <a href="https://ragrank.readthedocs.io/latest/">Documentation</a> |
         <a href="https://api-ragrank.readthedocs.io/">API reference</a> |
         <a href="https://ragrank.readthedocs.io/latest/get_started/basic_evaluation.html">Quickstart</a> |
-        <a href="https://discord.gg/yaFRx6ja">Join the Community</a>
+        <a href="https://discord.gg/KzfVpds3">Join the Community</a>
     <p>
 </h4>
 
@@ -73,7 +73,7 @@ data = from_dict({
 })
 
 # Evaluate the response relevance metric
-result = evaluate(data=data, metrics=[response_relevancy])
+result = evaluate(data, metrics=[response_relevancy])
 
 # Display the evaluation results
 result.to_dataframe()

docs/api_reference/conf.py

@@ -8,7 +8,7 @@
 project = "Ragrank"
 copyright = "2024, Izam Mohammed"
 author = "Izam Mohammed"
-release = "0.0.6"
+release = "0.0.7"
 
 
 # -- General configuration ---------

docs/docs/conf.py

@@ -9,7 +9,7 @@
 project = "Ragrank"
 copyright = "2024, Izam Mohammed"
 author = "Izam Mohammed"
-release = "0.0.6"
+release = "0.0.7"
 
 
 # -- General configuration ------

docs/docs/evaluation/result.md

@@ -17,7 +17,7 @@ data = DataNode(
 )
 
 result:EvalResult = evaluate(
-    dataset=data,
+    data ,
 )
 
 print(result.to_dict())

docs/docs/evaluation/with_llm.md

@@ -29,7 +29,7 @@ llm_configuration = LLMConfig(
 llm = OpenaiLLM(llm_config=llm_configuration)
 
 result = evaluate(
-    dataset=data,
+    data ,
     llm=llm,
 )
 
@@ -72,7 +72,7 @@ data = DataNode(
 )
 
 result = evaluate(
-    dataset = data,
+    data ,
     llm = ragrank_llm,
 )
 ```

docs/docs/evaluation/with_metrics.md

@@ -45,7 +45,7 @@ data = DataNode(
 
 # evaluating the metrics
 result = evaluate(
-    data = data,
+    data ,
     metrics=[
         response_relevancy,
         response_conciseness,

docs/docs/get_started/basic_evaluation.md

@@ -29,7 +29,7 @@ data = from_dict({
 })
 
 # Evaluate the response relevance metric
-result = evaluate(data=data, metrics=[response_relevancy])
+result = evaluate(data, metrics=[response_relevancy])
 
 # Display the evaluation results
 result.to_dataframe()

docs/docs/metrics/context_related/context_relevancy.md

@@ -24,7 +24,7 @@ data = DataNode(
 )
 
 result = evaluate(
-    dataset=data,
+    data ,
     metrics=[
         response_relevancy,
     ]

docs/docs/metrics/context_related/context_utilization.md

@@ -25,7 +25,7 @@ data = DataNode(
 )
 
 result = evaluate(
-    dataset=data,
+    data ,
     metrics=[
         response_relevancy,
     ]

docs/docs/metrics/custom_metrics/custom_instruct.md

@@ -57,7 +57,7 @@ data = DataNode(
 )
 
 result = evaluate(
-    dataset=data,
+    data ,
     metrics=[grammar_checker],
 )
 print(result)

docs/docs/metrics/custom_metrics/custom_metric.md

@@ -42,7 +42,7 @@ data = DataNode(
 )
 
 result = evaluate(
-    dataset=data,
+    data ,
     metrics=[
         my_metric,
     ]

docs/docs/metrics/response_related/response_conciseness.md

@@ -25,7 +25,7 @@ data = DataNode(
 )
 
 result = evaluate(
-    dataset=data,
+    data ,
     metrics=[
         response_conciseness,
     ]

docs/docs/metrics/response_related/response_relevancy.md

@@ -25,7 +25,7 @@ data = DataNode(
 )
 
 result = evaluate(
-    dataset=data,
+    data ,
     metrics=[
         response_relevancy,
     ]

docs/docs/more/contributing.md

@@ -34,33 +34,42 @@
 **5. Test Your Changes:**
    - Run tests to ensure your changes haven't introduced any regressions:
      ```
-     pytest
+     make test
      ```
 
-**6. Commit Your Changes:**
+**6. Linting and formating:**
+   - Format the code
+     ```
+     make format
+     ```
+   - Check the linting
+     ```
+     make lint
+     ```
+**7. Commit Your Changes:**
    - Once you're satisfied with your changes, commit them:
      ```
      git add .
      git commit -m "Add your descriptive commit message here"
      ```
 
-**7. Push Changes to Your Fork:**
+**8. Push Changes to Your Fork:**
    - Push your changes to your forked repository:
      ```
      git push origin my-feature
      ```
 
-**8. Create a Pull Request:**
+**9. Create a Pull Request:**
    - Go to your forked repository on GitHub.
    - Click on the "Compare & pull request" button next to your branch.
    - Fill out the pull request form with a descriptive title and details of your changes.
    - Click on the "Create pull request" button to submit your contribution.
 
-**9. Collaborate and Iterate:**
+**10. Collaborate and Iterate:**
    - Engage with reviewers and address any feedback or requests for changes.
    - Iterate on your code until it meets the project's standards and requirements.
 
-**10. Stay Updated:**
+**11. Stay Updated:**
    - Keep an eye on the pull request for any updates or requests from maintainers.
    - Stay engaged with the Ragrank community and contribute to discussions and future development efforts.
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ragrank"
-version = "0.0.6"
+version = "0.0.7"
 description = "An evaluation library for RAG models"
 authors = ["Izam Mohammed <[email protected]>"]
 license = "Apache-2.0"

src/ragrank/_version.py

@@ -1 +1 @@
-__version__: str = "0.0.6"
+__version__: str = "0.0.7"

src/ragrank/constants.py

@@ -16,6 +16,6 @@
     RESPONSE_FIELD,
 ]
 
-SERVER_URL: str = "https://ragrank-trace.vercel.app/"
+SERVER_URL: str = "https://ragrank-trace.onrender.com/api/"
 DEBUG_MODE: str = "DEBUG_MODE_ON"
 REQUEST_TIME_OUT: float = 10.0