Fixes package and adds some readme notes (#560)

* Fixes package and adds some readme notes * Apply spotless formatting --------- Co-authored-by: fedefernandez <[email protected]>
xebia-functional · Nov 24, 2023 · 3cd9754 · 3cd9754
1 parent 954e976
commit 3cd9754
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 17 deletions.
diff --git a/evaluator-example/README.md b/evaluator-example/README.md
@@ -12,14 +12,26 @@ adapt to your needs.
 
 You need to have the following installed:
 
-- [Install Poetry](https://python-poetry.org/docs/#installing-with-pipx) 
-- **Python 3.10.0:** you can configure it with virtualenv
+- [Install virtualenv](https://virtualenv.pypa.io/en/latest/installation.html)
+
+```shell
+pipx install virtualenv
+```
+
+- [Install Poetry](https://python-poetry.org/docs/#installing-with-pipx)
+
+**Note**: Poetry requires **Python 3.10.x**. You can use [pyenv](https://github.com/pyenv/pyenv) to
+easily switch between multiple versions of Python.
+
+Then, you can configure your local environment with virtualenv
+
 ```bash
-virtualenv venv --python=python3.10.0.
-source venv/bin/activate.
+# Change with your Python patch version 
+virtualenv venv --python=python3.10.0
+source venv/bin/activate
 ```
 
-When you have Poetry installed, you can install the dependencies. You have to
+Once you have Poetry installed, you can install the dependencies. You have to
 move to `evalTest` folder and execute the following command:
 
 ```bash

diff --git a/...nal/xef/evaluator/examples/TestExample.kt → ...nal/xef/evaluator/examples/TestExample.kt b/...nal/xef/evaluator/examples/TestExample.kt → ...nal/xef/evaluator/examples/TestExample.kt
@@ -1,13 +1,13 @@
-package com.xebia.funcional.xef.evaluator.examples
+package com.xebia.functional.xef.evaluator.examples
 
 import arrow.continuations.SuspendApp
-import com.xebia.funcional.xef.evaluator.TestSpecItem
-import com.xebia.funcional.xef.evaluator.TestsSpec
-import com.xebia.funcional.xef.evaluator.models.ContextDescription
-import com.xebia.funcional.xef.evaluator.models.OutputDescription
-import com.xebia.funcional.xef.evaluator.models.OutputResponse
 import com.xebia.functional.xef.conversation.llm.openai.OpenAI
 import com.xebia.functional.xef.conversation.llm.openai.promptMessage
+import com.xebia.functional.xef.evaluator.TestSpecItem
+import com.xebia.functional.xef.evaluator.TestsSpec
+import com.xebia.functional.xef.evaluator.models.ContextDescription
+import com.xebia.functional.xef.evaluator.models.OutputDescription
+import com.xebia.functional.xef.evaluator.models.OutputResponse
 import java.io.File
 
 object TestExample {

diff --git a/...a/funcional/xef/evaluator/SuiteBuilder.kt → .../functional/xef/evaluator/SuiteBuilder.kt b/...a/funcional/xef/evaluator/SuiteBuilder.kt → .../functional/xef/evaluator/SuiteBuilder.kt
@@ -1,6 +1,6 @@
-package com.xebia.funcional.xef.evaluator
+package com.xebia.functional.xef.evaluator
 
-import com.xebia.funcional.xef.evaluator.models.OutputDescription
+import com.xebia.functional.xef.evaluator.models.OutputDescription
 import kotlin.jvm.JvmSynthetic
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable

diff --git a/...uncional/xef/evaluator/TestItemBuilder.kt → ...nctional/xef/evaluator/TestItemBuilder.kt b/...uncional/xef/evaluator/TestItemBuilder.kt → ...nctional/xef/evaluator/TestItemBuilder.kt
@@ -1,7 +1,7 @@
-package com.xebia.funcional.xef.evaluator
+package com.xebia.functional.xef.evaluator
 
-import com.xebia.funcional.xef.evaluator.models.ContextDescription
-import com.xebia.funcional.xef.evaluator.models.OutputResponse
+import com.xebia.functional.xef.evaluator.models.ContextDescription
+import com.xebia.functional.xef.evaluator.models.OutputResponse
 
 class TestItemBuilder(val input: String) {
 

diff --git a/...cional/xef/evaluator/models/TestModels.kt → ...tional/xef/evaluator/models/TestModels.kt b/...cional/xef/evaluator/models/TestModels.kt → ...tional/xef/evaluator/models/TestModels.kt
@@ -1,4 +1,4 @@
-package com.xebia.funcional.xef.evaluator.models
+package com.xebia.functional.xef.evaluator.models
 
 import kotlin.jvm.JvmSynthetic