edsl 0.1.14__py3-none-any.whl → 0.1.40__py3-none-any.whl

edsl/questions/QuestionNumerical.py

@@ -1,98 +1,151 @@
 from __future__ import annotations
-import textwrap
+
 from random import uniform
-from typing import Any, Optional, Union
-from edsl.exceptions import QuestionAnswerValidationError
-from edsl.questions import Question
+from typing import Any, Optional, Union, Literal
+
+from pydantic import BaseModel, Field, field_validator
+
+from edsl.exceptions.questions import QuestionAnswerValidationError
+from edsl.questions.QuestionBase import QuestionBase
 from edsl.questions.descriptors import NumericalOrNoneDescriptor
-from edsl.scenarios import Scenario
-from edsl.utilities import random_string
+from edsl.questions.decorators import inject_exception
+from edsl.questions.response_validator_abc import ResponseValidatorABC
 
 
-class QuestionNumerical(Question):
-    """
-    This question asks the user to answer with a numerical value.
+def create_numeric_response(
+    min_value: Optional[float] = None,
+    max_value: Optional[float] = None,
+    permissive=False,
+):
+    field_kwargs = {}
+    if not permissive:
+        field_kwargs = {}
+        if min_value is not None:
+            field_kwargs["ge"] = min_value
+        if max_value is not None:
+            field_kwargs["le"] = max_value
+
+    class ConstrainedNumericResponse(BaseModel):
+        answer: Union[int, float] = Field(**field_kwargs)
+        comment: Optional[str] = Field(None)
+        generated_tokens: Optional[Any] = Field(None)
+
+    return ConstrainedNumericResponse
+
+
+class NumericalResponseValidator(ResponseValidatorABC):
+    required_params = ["min_value", "max_value", "permissive"]
+
+    valid_examples = [
+        ({"answer": 1}, {"min_value": 0, "max_value": 10}),
+        ({"answer": 1}, {"min_value": None, "max_value": None}),
+    ]
+
+    invalid_examples = [
+        ({"answer": 10}, {"min_value": 0, "max_value": 5}, "Answer is out of range"),
+        ({"answer": "ten"}, {"min_value": 0, "max_value": 5}, "Answer is not a number"),
+        ({}, {"min_value": 0, "max_value": 5}, "Answer key is missing"),
+    ]
 
-    Arguments:
-    - `question_name` is the name of the question (string)
-    - `question_text` is the text of the question (string)
+    def fix(self, response, verbose=False):
+        response_text = str(response).lower()
+        import re
 
-    Optional arguments:
-    - `min_value` is the minimum value of the answer (float)
-    - `max_value` is the maximum value of the answer (float)
-    - `instructions` are the instructions for the question (string). If not provided, the default instructions are used. To view them, run `QuestionNumerical.default_instructions`
+        if verbose:
+            print(f"Ivalid generated tokens was was: {response_text}")
+        pattern = r"\b\d+(?:\.\d+)?\b"
+        match = re.search(pattern, response_text.replace(",", ""))
+        solution = match.group(0) if match else response.get("answer")
+        if verbose:
+            print("Proposed solution is: ", solution)
+        if "comment" in response:
+            return {"answer": solution, "comment": response["comment"]}
+        else:
+            return {"answer": solution}
 
+    def _check_constraints(self, pydantic_edsl_answer: BaseModel):
+        pass
+
+
+class QuestionNumerical(QuestionBase):
+    """This question prompts the agent to answer with a numerical value.
+
+    >>> QuestionNumerical.self_check()
 
-    For an example, run `QuestionNumerical.example()`
     """
 
     question_type = "numerical"
     min_value: Optional[float] = NumericalOrNoneDescriptor()
     max_value: Optional[float] = NumericalOrNoneDescriptor()
 
+    _response_model = None
+    response_validator_class = NumericalResponseValidator
+
     def __init__(
         self,
         question_name: str,
         question_text: str,
         min_value: Optional[Union[int, float]] = None,
         max_value: Optional[Union[int, float]] = None,
+        include_comment: bool = True,
+        question_presentation: Optional[str] = None,
+        answering_instructions: Optional[str] = None,
+        permissive: bool = False,
     ):
+        """Initialize the question.
+
+        :param question_name: The name of the question.
+        :param question_text: The text of the question.
+        :param min_value: The minimum value of the answer.
+        :param max_value: The maximum value of the answer.
+        """
         self.question_name = question_name
         self.question_text = question_text
         self.min_value = min_value
         self.max_value = max_value
 
+        self.include_comment = include_comment
+        self.question_presentation = question_presentation
+        self.answering_instructions = answering_instructions
+        self.permissive = permissive
+
+    def create_response_model(self):
+        return create_numeric_response(self.min_value, self.max_value, self.permissive)
+
     ################
     # Answer methods
     ################
-    def validate_answer(
-        self, answer: dict[str, Any]
-    ) -> dict[str, Union[str, float, int]]:
-        """Validates the answer"""
-        self.validate_answer_template_basic(answer)
-        self.validate_answer_key_value_numeric(answer, "answer")
-        self.validate_answer_numerical(answer)
-        return answer
-
-    def translate_answer_code_to_answer(self, answer, scenario: Scenario = None):
-        """There is no answer code."""
-        return answer
-
-    def simulate_answer(self, human_readable: bool = True):
-        """Simulates a valid answer for debugging purposes"""
-        return {
-            "answer": uniform(self.min_value, self.max_value),
-            "comment": random_string(),
-        }
+
+    @property
+    def question_html_content(self) -> str:
+        from jinja2 import Template
+
+        question_html_content = Template(
+            """
+        <div>
+        <input type="number" id="{{ question_name }}" name="{{ question_name }}">
+        </div>
+        """
+        ).render(question_name=self.question_name)
+        return question_html_content
 
     ################
     # Helpful methods
     ################
     @classmethod
-    def example(cls) -> QuestionNumerical:
+    @inject_exception
+    def example(cls, include_comment=False) -> QuestionNumerical:
+        """Return an example question."""
         return cls(
             question_name="age",
-            question_text="How old are you in years?",
+            question_text="You are a 45 year old man. How old are you in years?",
             min_value=0,
             max_value=86.7,
+            include_comment=include_comment,
         )
 
 
-def main():
-    from edsl.questions.QuestionNumerical import QuestionNumerical
-
-    q = QuestionNumerical.example()
-    q.question_text
-    q.min_value
-    q.max_value
-    # validate an answer
-    q.validate_answer({"answer": 1, "comment": "I like custard"})
-    # translate answer code
-    q.translate_answer_code_to_answer(1)
-    # simulate answer
-    q.simulate_answer()
-    q.simulate_answer(human_readable=False)
-    q.validate_answer(q.simulate_answer(human_readable=False))
-    # serialization (inherits from Question)
-    q.to_dict()
-    assert q.from_dict(q.to_dict()) == q
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod(optionflags=doctest.ELLIPSIS)

edsl/questions/QuestionRank.py

@@ -1,119 +1,314 @@
 from __future__ import annotations
-import random
-import textwrap
-from jinja2 import Template
-from typing import Any, Optional, Union
-from edsl.questions import Question
-from edsl.exceptions import QuestionAnswerValidationError
-from edsl.scenarios import Scenario
-from edsl.utilities.utilities import random_string
+from typing import Optional, Any, List, Annotated, Literal
+
+from pydantic import BaseModel, Field
+
+from edsl.questions.QuestionBase import QuestionBase
 from edsl.questions.descriptors import (
     QuestionOptionsDescriptor,
     NumSelectionsDescriptor,
 )
+from edsl.questions.response_validator_abc import ResponseValidatorABC
 
 
-class QuestionRank(Question):
+def create_response_model(
+    choices: list,
+    num_selections: Optional[int] = None,
+    permissive: bool = False,
+):
+    """
+    :param choices: A list of allowed values for the answer field.
+    :param include_comment: Whether to include a comment field in the model.
+    :return: A new Pydantic model class.
     """
-    This question asks the user to rank options from a list.
+    # Convert the choices list to a tuple for use with Literal
+    choice_tuple = tuple(choices)
 
-    Arguments:
-    - `question_name` is the name of the question (string)
-    - `question_options` are the options the user should select from (list of strings)
-    - `question_text` is the text of the question (string)
+    field_params = {}
+    if num_selections is not None and not permissive:
+        field_params["min_items"] = num_selections
+        field_params["max_items"] = num_selections
 
-    Optional arguments:
-    - `num_selections` is the number of options that must be selected (positive integer)
-    - `instructions` are the instructions for the question (string). If not provided, the default instructions are used. To view them, run `QuestionRank.default_instructions`
-    - `short_names_dict` maps question_options to short names (dictionary mapping strings to strings)
+    class RankResponse(BaseModel):
+        answer: Annotated[
+            List[Literal[choice_tuple]],
+            Field(..., **field_params),
+        ] = Field(..., description="List of selected choices")
+        comment: Optional[str] = Field(None, description="Optional comment field")
+        generated_tokens: Optional[Any] = Field(None)
 
-    For an example, run `QuestionRank.example()`
-    """
+        class Config:
+            @staticmethod
+            def json_schema_extra(schema: dict, model: BaseModel) -> None:
+                # Add the list of choices to the schema for better documentation
+                for prop in schema.get("properties", {}).values():
+                    if prop.get("title") == "answer":
+                        prop["items"] = {"enum": choices}
+
+    return RankResponse
+
+
+class RankResponseValidator(ResponseValidatorABC):
+    required_params = ["num_selections", "permissive", "use_code", "question_options"]
+    valid_examples = []
+    invalid_examples = []
+
+    def fix(self, response, verbose=False):
+        if verbose:
+            print("Invalid response of QuestionRank was: ", False)
+        response_text = response.get("generated_tokens")
+        if response_text is None or response_text == "":  # nothing to be done
+            return response
+        # Maybe it's a comma separated list?
+        response_text = str(response.get("answer"))
+        proposed_list = (
+            response_text.replace("[", "").replace("]", "").replace("'", "").split(",")
+        )
+        proposed_list = [item.strip() for item in proposed_list]
+
+        if verbose:
+            print("Using code? ", self.use_code)
+        if self.use_code:
+            try:
+                proposed_list = [int(i) for i in proposed_list]
+            except ValueError:
+                # print("Could not convert to int")
+                pass
+
+        if verbose:
+            print("Proposed solution is: ", proposed_list)
+
+        # print(f"Ivalid generated tokens was was: {response_text}")
+        if "comment" in response:
+            proposed_data = {
+                "answer": proposed_list,
+                "comment": response["comment"],
+                "generated_tokens": response.get("generated_tokens", None),
+            }
+        else:
+            proposed_data = {
+                "answer": proposed_list,
+                "generated_tokens": response.get("generated_tokens", None),
+            }
+
+        try:
+            self.response_model(**proposed_data)
+            return proposed_data
+        except Exception as e:
+            if verbose:
+                print(f"Proposed solution {proposed_data} is invalid. Error: {e}")
+            # return response
+        if verbose:
+            print("Now seeing if responses show up in the answer")
+        matches = []
+        for index, option in enumerate(self.question_options):
+            if self.use_code:
+                if str(index) in response_text:
+                    if index not in matches:
+                        matches.append(index)
+            else:
+                if option in response_text:
+                    if option not in matches:
+                        matches.append(option)
+        proposed_data = {
+            "answer": matches,
+            "comment": response.get("comment", None),
+            "generated_tokens": response.get("generated_tokens", None),
+        }
+        try:
+            self.response_model(**proposed_data)
+            return proposed_data
+        except Exception as e:
+            if verbose:
+                print(f"Proposed solution {proposed_data} is invalid. Error: {e}")
+            return response
+
+
+class QuestionRank(QuestionBase):
+    """This question prompts the agent to rank options from a list."""
 
     question_type = "rank"
     question_options: list[str] = QuestionOptionsDescriptor()
     num_selections = NumSelectionsDescriptor()
 
+    _response_model = None
+    response_validator_class = RankResponseValidator
+
     def __init__(
         self,
         question_name: str,
         question_text: str,
         question_options: list[str],
         num_selections: Optional[int] = None,
-        short_names_dict: Optional[dict[str, str]] = None,
+        question_presentation: Optional[str] = None,
+        answering_instructions: Optional[str] = None,
+        permissive: bool = False,
+        use_code: bool = True,
+        include_comment: bool = True,
     ):
+        """Initialize the question.
+
+        :param question_name: The name of the question.
+        :param question_text: The text of the question.
+        :param question_options: The options the respondent should select from.
+        :param min_selections: The minimum number of options that must be selected.
+        :param max_selections: The maximum number of options that must be selected.
+        """
         self.question_name = question_name
         self.question_text = question_text
         self.question_options = question_options
-        self.short_names_dict = short_names_dict or dict()
         self.num_selections = num_selections or len(question_options)
+        self.question_presentation = question_presentation
+        self.answering_instructions = answering_instructions
+        self.permissive = permissive
+        self.use_code = use_code
+        self.include_comment = include_comment
+
+    def create_response_model(self):
+        choices = (
+            self.question_options
+            if not self.use_code
+            else range(len(self.question_options))
+        )
+        return create_response_model(
+            choices=choices,
+            num_selections=self.num_selections,
+            permissive=self.permissive,
+        )
 
     ################
     # Answer methods
     ################
-    def validate_answer(self, answer: Any) -> dict[str, list[int]]:
-        self.validate_answer_template_basic(answer)
-        self.validate_answer_key_value(answer, "answer", list)
-        self.validate_answer_rank(answer)
-        return answer
+    # def _validate_answer(self, answer: Any) -> dict[str, list[int]]:
+    #     """Validate the answer."""
+    #     self._validate_answer_template_basic(answer)
+    #     self._validate_answer_key_value(answer, "answer", list)
+    #     self._validate_answer_rank(answer)
+    #     return answer
 
-    def translate_answer_code_to_answer(
+    def _translate_answer_code_to_answer(
         self, answer_codes, scenario: Scenario = None
     ) -> list[str]:
-        """Translates the answer code to the actual answer."""
+        """Translate the answer code to the actual answer."""
+        from edsl.scenarios.Scenario import Scenario
+        from jinja2 import Template
+
         scenario = scenario or Scenario()
         translated_options = [
             Template(option).render(scenario) for option in self.question_options
         ]
         translated_codes = []
         for answer_code in answer_codes:
-            translated_codes.append(translated_options[int(answer_code)])
+            if self._use_code:
+                translated_codes.append(translated_options[int(answer_code)])
+            else:
+                translated_codes.append(answer_code)
         return translated_codes
 
-    def simulate_answer(self, human_readable=True) -> dict[str, Union[int, str]]:
-        """Simulates a valid answer for debugging purposes"""
-        if human_readable:
-            selected = random.sample(self.question_options, self.num_selections)
-        else:
-            selected = random.sample(
-                range(len(self.question_options)), self.num_selections
-            )
-        answer = {
-            "answer": selected,
-            "comment": random_string(),
+    # def _simulate_answer(self, human_readable=True) -> dict[str, Union[int, str]]:
+    #     """Simulate a valid answer for debugging purposes."""
+    #     from edsl.utilities.utilities import random_string
+
+    #     if human_readable:
+    #         selected = random.sample(self.question_options, self.num_selections)
+    #     else:
+    #         selected = random.sample(
+    #             range(len(self.question_options)), self.num_selections
+    #         )
+    #     answer = {
+    #         "answer": selected,
+    #         "comment": random_string(),
+    #     }
+    #     return answer
+
+    @property
+    def question_html_content(self) -> str:
+        from jinja2 import Template
+
+        question_html_content = Template(
+            """
+        <form id="rankForm">
+            <p>{{ question_text }}</p>
+            {% for option in question_options %}
+            <div>
+                <label for="{{ option }}">{{ option }}</label>
+                <input type="number" id="{{ option }}" name="{{ question_name }}[{{ option }}]" value="0" min="1" max="{{ question_options|length }}" oninput="updateRankings()">
+            </div>
+            {% endfor %}
+        </form>
+        <script>
+        function updateRankings() {
+            let options = {{ question_options|length }};
+            let values = [];
+            let isValid = true;
+
+            {% for option in question_options %}
+            let value = parseInt(document.getElementById("{{ option }}").value) || 0;
+            if (value > 0 && value <= options && !values.includes(value)) {
+                values.push(value);
+            } else if (value !== 0) {
+                isValid = false;
+            }
+            {% endfor %}
+
+            if (!isValid || values.length !== new Set(values).size) {
+                document.getElementById("error").innerText = "Please enter unique and valid ranks for each option.";
+            } else {
+                document.getElementById("error").innerText = "";
+            }
         }
-        return answer
+        </script>
+        <p id="error" style="color: red;"></p>
+        """
+        ).render(
+            question_name=self.question_name,
+            question_text=self.question_text,
+            question_options=self.question_options,
+        )
+        return question_html_content
 
     ################
     # Helpful methods
     ################
     @classmethod
-    def example(cls) -> QuestionRank:
+    def example(cls, use_code=False, include_comment=True) -> QuestionRank:
+        """Return an example question."""
         return cls(
             question_name="rank_foods",
             question_text="Rank your favorite foods.",
             question_options=["Pizza", "Pasta", "Salad", "Soup"],
             num_selections=2,
+            use_code=use_code,
+            include_comment=include_comment,
         )
 
 
 def main():
+    """Show example usage."""
     from edsl.questions.QuestionRank import QuestionRank
 
-    q = QuestionRank.example()
+    q = QuestionRank.example(use_code=True)
     q.question_text
     q.question_name
     q.question_options
     q.num_selections
     # validate an answer
     answer = {"answer": [0, 1], "comment": "I like pizza and pasta."}
-    q.validate_answer(answer)
+    q._validate_answer(answer)
     # translate an answer code to an answer
-    q.translate_answer_code_to_answer([0, 1])
+    # q._translate_answer_code_to_answer([0, 1])
     # simulate answer
-    q.simulate_answer()
-    q.simulate_answer(human_readable=False)
-    q.validate_answer(q.simulate_answer(human_readable=False))
+    q._simulate_answer()
+    q._simulate_answer(human_readable=False)
+    q._validate_answer(q._simulate_answer(human_readable=False))
     # serialization (inherits from Question)
     q.to_dict()
     assert q.from_dict(q.to_dict()) == q
+
+    q = QuestionRank.example(use_code=False)
+    answer = {"answer": ["Pizza", "Pasta"], "comment": "I like pizza and pasta."}
+    q._validate_answer(answer)
+
+    import doctest
+
+    doctest.testmod(optionflags=doctest.ELLIPSIS)

edsl/questions/Quick.py

@@ -0,0 +1,41 @@
+from edsl import (
+    QuestionFreeText,
+    QuestionMultipleChoice,
+    Survey,
+    QuestionList,
+    Question,
+)
+
+
+def Quick(question_text):
+    q_type = QuestionMultipleChoice(
+        question_text=f"A researcher is asking a language model this: {question_text}. What is the most appropriate type of question to ask?",
+        question_name="potential_question_type",
+        question_options=["multiple_choice", "list", "free_text"],
+    )
+
+    q_name = QuestionFreeText(
+        question_text=f"A researcher is asking a language model this: {question_text}. What is a good name for this question that's a valid python identifier? Just return the proposed identifer",
+        question_name="potential_question_name",
+    )
+
+    q_options = QuestionList(
+        question_text=f"A research is asking this question: { question_text }. What are the possible options for this question?",
+        question_name="potential_question_options",
+    )
+
+    survey = Survey([q_type, q_name, q_options]).add_skip_rule(
+        q_options, "{{ potential_question_type }} != 'multiple_choice'"
+    )
+    return survey
+    # results = survey.run()
+    # question_type = results.select("potential_question_type").first()
+    # question_options = results.select("potential_question_options").first()
+    # question_name = results.select("potential_question_name").first()
+    # print("Question Type: ", question_type)
+    # print("Question Name: ", question_name)
+    # print("Question Options: ", question_options)
+    # if question_options == None:
+    #     return Question(question_type, question_name = question_name)
+    # else:
+    #     return Question(question_type, question_name = question_name, question_options = question_options)