edsl 0.1.33__py3-none-any.whl → 0.1.33.dev1__py3-none-any.whl

edsl/questions/ResponseValidatorABC.py

@@ -1,170 +0,0 @@
-from abc import ABC, abstractmethod
-from pydantic import BaseModel, Field, field_validator
-
-# from decimal import Decimal
-from typing import Optional, Any, List, TypedDict
-
-from edsl.exceptions import QuestionAnswerValidationError
-from pydantic import ValidationError
-
-
-class BaseResponse(BaseModel):
-    answer: Any
-    comment: Optional[str] = None
-    generated_tokens: Optional[str] = None
-
-
-class ResponseValidatorABC(ABC):
-    required_params: List[str] = []
-
-    def __init_subclass__(cls, **kwargs):
-        super().__init_subclass__(**kwargs)
-        required_class_vars = ["required_params", "valid_examples", "invalid_examples"]
-        for var in required_class_vars:
-            if not hasattr(cls, var):
-                raise ValueError(f"Class {cls.__name__} must have a '{var}' attribute.")
-
-    def __init__(
-        self,
-        response_model: type[BaseModel],
-        exception_to_throw: Optional[Exception] = None,
-        override_answer: Optional[dict] = None,
-        **kwargs,
-    ):
-        self.response_model = response_model
-        self.exception_to_throw = exception_to_throw  # for testing
-        self.override_answer = override_answer  # for testing
-        self.original_exception = None
-
-        # Validate required parameters
-        missing_params = [
-            param for param in self.required_params if param not in kwargs
-        ]
-        if missing_params:
-            raise ValueError(
-                f"Missing required parameters: {', '.join(missing_params)}"
-            )
-
-        # Set attributes
-        for key, value in kwargs.items():
-            setattr(self, key, value)
-
-        if not hasattr(self, "permissive"):
-            self.permissive = False
-
-        self.fixes_tried = 0
-
-    class RawEdslAnswerDict(TypedDict):
-        answer: Any
-        comment: Optional[str]
-        generated_tokens: Optional[str]
-
-    def _preprocess(self, data: RawEdslAnswerDict) -> RawEdslAnswerDict:
-        """This is for testing purposes. A question can be given an exception to throw or an answer to always return.
-
-        >>> rv = ResponseValidatorABC.example()
-        >>> rv.override_answer = {"answer": 42}
-        >>> rv.validate({"answer": 23})
-        {'answer': 42, 'comment': None, 'generated_tokens': None}
-        """
-        if self.exception_to_throw:
-            raise self.exception_to_throw
-        return self.override_answer if self.override_answer else data
-
-    def _base_validate(self, data: RawEdslAnswerDict) -> BaseModel:
-        """This is the main validation function. It takes the response_model and checks the data against it, returning the instantiated model.
-
-        >>> rv = ResponseValidatorABC.example("numerical")
-        >>> rv._base_validate({"answer": 42})
-        ConstrainedNumericResponse(answer=42, comment=None, generated_tokens=None)
-        """
-        try:
-            return self.response_model(**data)
-        except ValidationError as e:
-            raise QuestionAnswerValidationError(e, data=data, model=self.response_model)
-
-    def post_validation_answer_convert(self, data):
-        return data
-
-    class EdslAnswerDict(TypedDict):
-        answer: Any
-        comment: Optional[str]
-        generated_tokens: Optional[str]
-
-    def validate(
-        self, raw_edsl_answer_dict: RawEdslAnswerDict, fix=False, verbose=False
-    ) -> EdslAnswerDict:
-        """This is the main validation function.
-
-        >>> rv = ResponseValidatorABC.example("numerical")
-        >>> rv.validate({"answer": 42})
-        {'answer': 42, 'comment': None, 'generated_tokens': None}
-        >>> rv.max_value
-        86.7
-        >>> rv.validate({"answer": "120"})
-        Traceback (most recent call last):
-        ...
-        edsl.exceptions.questions.QuestionAnswerValidationError:...
-        >>> from edsl import QuestionNumerical
-        >>> q = QuestionNumerical.example()
-        >>> q.permissive = True
-        >>> rv = q.response_validator
-        >>> rv.validate({"answer": "120"})
-        {'answer': 120, 'comment': None, 'generated_tokens': None}
-        >>> rv.validate({"answer": "poo"})
-        Traceback (most recent call last):
-        ...
-        edsl.exceptions.questions.QuestionAnswerValidationError:...
-        """
-        proposed_edsl_answer_dict = self._preprocess(raw_edsl_answer_dict)
-        try:
-            pydantic_edsl_answer: BaseModel = self._base_validate(
-                proposed_edsl_answer_dict
-            )
-            edsl_answer_dict = self._extract_answer(pydantic_edsl_answer)
-            return self._post_process(edsl_answer_dict)
-        except QuestionAnswerValidationError as e:
-            if verbose:
-                print(f"Failed to validate {raw_edsl_answer_dict}; {str(e)}")
-            return self._handle_exception(e, raw_edsl_answer_dict)
-
-    def _handle_exception(self, e: Exception, raw_edsl_answer_dict) -> EdslAnswerDict:
-        if self.fixes_tried == 0:
-            self.original_exception = e
-
-        if self.fixes_tried == 0 and hasattr(self, "fix"):
-            self.fixes_tried += 1
-            fixed_data = self.fix(raw_edsl_answer_dict)
-            try:
-                return self.validate(fixed_data, fix=True)
-            except Exception as e:
-                pass  # we don't log failed fixes
-
-        raise QuestionAnswerValidationError(
-            self.original_exception,
-            data=raw_edsl_answer_dict,
-            model=self.response_model,
-        )
-
-    def _check_constraints(self, pydantic_edsl_answer: BaseModel) -> dict:
-        pass
-
-    def _extract_answer(self, response: BaseModel) -> EdslAnswerDict:
-        return response.model_dump()
-
-    def _post_process(self, edsl_answer_dict: EdslAnswerDict) -> EdslAnswerDict:
-        return edsl_answer_dict
-
-    @classmethod
-    def example(cls, question_type="numerical"):
-        from edsl import Question
-
-        q = Question.example(question_type)
-        return q.response_validator
-
-
-# Example usage
-if __name__ == "__main__":
-    import doctest
-
-    doctest.testmod(optionflags=doctest.ELLIPSIS)

edsl/questions/decorators.py

@@ -1,21 +0,0 @@
-from typing import Optional, Callable, TypeVar
-
-T = TypeVar("T")
-
-
-def inject_exception(func: Callable[..., T]) -> Callable[..., T]:
-    def wrapper(
-        cls,
-        exception_to_throw: Optional[Exception] = None,
-        override_answer: Optional[dict] = None,
-        *args,
-        **kwargs
-    ) -> T:
-        base_instance = func(cls, *args, **kwargs)
-        if exception_to_throw:
-            base_instance.exception_to_throw = exception_to_throw
-        if override_answer:
-            base_instance.override_answer = override_answer
-        return base_instance
-
-    return wrapper

edsl/questions/prompt_templates/question_budget.jinja

@@ -1,13 +0,0 @@
-You are being asked the following question: {{question_text}}
-The options are:
-{% for option in question_options %}
-    {{ loop.index0 }}: {{option}}
-{% endfor %}                       
-Return a valid JSON formatted as follows, with a dictionary for your "answer" 
-where the keys are the option numbers and the values are the amounts you want 
-to allocate to the options, and the sum of the values is {{budget_sum}}:
-
-{"answer": {<put dict of option numbers and allocation amounts here>}, "comment": "<put explanation here>"}
-Example response for a budget of 100 and 4 options: 
-{"answer": {"0": 25, "1": 25, "2": 25, "3": 25}, "comment": "I allocated 25 to each option."}
-There must be an allocation listed for each item (including 0).

edsl/questions/prompt_templates/question_checkbox.jinja

@@ -1,32 +0,0 @@
-{# Question Presention #}
-{{question_text}}
-{% if use_code %}
-    {% for option in question_options %}
-        {{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-        {{ option }}
-    {% endfor %}    
-{% endif %}
-
-{# Restrictions #}
-{% if min_selections != None and max_selections != None and min_selections == max_selections %}
-    You must select exactly {{min_selections}} options.
-{% elif min_selections != None and max_selections != None %}
-    Minimum number of options that must be selected: {{min_selections}}.
-    Maximum number of options that must be selected: {{max_selections}}.
-{% elif min_selections != None %}
-    Minimum number of options that must be selected: {{min_selections}}.
-{% elif max_selections != None %}
-    Maximum number of options that must be selected: {{max_selections}}.
-{% endif %}
-
-{# Answering Instructions #}
-Please respond with valid JSON, formatted like so:
-{% if include_comment %}
-    {"answer": [<put comma-separated list here>], "comment": "<put explanation here>"}
-{% else %}
-    {"answer": [<put comma-separated list here>]}
-{% endif %}
-

edsl/questions/prompt_templates/question_extract.jinja

@@ -1,11 +0,0 @@
-{{question_text}}
-
-Create an ANSWER should be formatted like this: 
-{{ answer_template }}
-
-It should have the same keys but values extracted from the input.
-If the value of a key is not present in the input, fill with "null".
-
-Return a valid JSON formatted like this:
-{"answer": <put your ANSWER here>}
-ONLY RETURN THE JSON, AND NOTHING ELSE.

edsl/questions/prompt_templates/question_free_text.jinja

@@ -1,3 +0,0 @@
-{{question_text}}
-Return a valid JSON formatted like this: 
-{"answer": "<put free text answer here>"}

edsl/questions/prompt_templates/question_linear_scale.jinja

@@ -1,11 +0,0 @@
-    {{question_text}}
-        {% for option in question_options %}
-            {{option}} : {{ option_labels.get(option, "") }}
-        {% endfor %}
-    Return a valid JSON formatted like this, selecting only the code of the option (codes start at 0):
-    {% if include_comment %}  
-        {"answer": <put answer code here>, "comment": <comment>} 
-    {% else %} 
-        {"answer": <put answer here>} 
-    {% endif %}
-    Only 1 option may be selected.

edsl/questions/prompt_templates/question_list.jinja

@@ -1,17 +0,0 @@
-{{question_text}}
-
-Your response should be only a valid JSON in the following format:
-{% if include_comment %}
-    {
-    "answer": [<comma-separated list of responsive words or phrases as independent strings>],
-    "comment": "<put comment here>"
-    }
-{% else %}
-    {
-    "answer": [<comma-separated list of responsive words or phrases as independent strings>],
-    }
-{% endif %}
-
-{% if max_list_items is not none %}
-The list must not contain more than {{ max_list_items }} items.
-{% endif %}

edsl/questions/prompt_templates/question_multiple_choice.jinja

@@ -1,33 +0,0 @@
-{# Question Presention #}
-{{question_text}}
-
-{% if use_code %}
-    {% for option in question_options %}
-        {{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-        {{option}}
-    {% endfor %}
-{% endif %}
-
-Only 1 option may be selected.
-
-{# Answering Instructions #}
-Return a valid JSON formatted like this:
-
-{% if use_code %}
-    {% if include_comment %}
-        {"answer": <put answer code here>, "comment": "<put explanation here>"}
-    {% else %}
-        {"answer": <put answer code here>}
-    {% endif %}
-{% else %}
-
-    {% if include_comment %}
-        {"answer": <text of option>, "comment": "<put explanation here>"}
-    {% else %}
-        {"answer": <put option here>}
-    {% endif %}
-
-{% endif %}

edsl/questions/prompt_templates/question_numerical.jinja

@@ -1,37 +0,0 @@
-You are being asked a question that requires a numerical response 
-in the form of an integer or decimal (e.g., -12, 0, 1, 2, 3.45, ...).
-        
-Your response must be in the following format:
-
-{% if include_comment %}
-    {"answer": "<your numerical answer here>", "comment": "<your explanation here>"}
-{% else %}
-    {"answer": "<your numerical answer here>"}
-{% endif %}
-
-You must only include an integer or decimal in the quoted "answer" part of your response.
-        
-Here is an example of a valid response:
-{% if include_comment %}
-    {"answer": "100", "comment": "This is my explanation..."}
-{% else %}
-    {"answer": "100"}
-{% endif %}
-        
-Here is an example of a response that is invalid because the "answer" includes words:
-{"answer": "I don't know.", ...}
-
-If your response is equivalent to zero, your formatted response should look like this:
-{% if include_comment %}
-    {"answer": "0", "comment": "This is my explanation..."}
-{% else %}
-    {"answer": "0"}
-{% endif %}
-
-You are being asked the following question: {{question_text}}
-{% if min_value is not none %}
-    Minimum answer value: {{min_value}}
-{% endif %}
-{% if max_value is not none %}
-    Maximum answer value: {{max_value}}
-{% endif %}

edsl/questions/templates/budget/answering_instructions.jinja

@@ -1,7 +0,0 @@
-Return only a comma-separated list the values in the same order as the options, with 0s included, on one line, in square braces.
-
-Example: if there are 4 options, the response should be "[25,25,25,25]" to allocate 25 to each option.
-
-{% if include_comment %}
-After the answer, you can put a comment explaining your choice on the next line.
-{% endif %}

edsl/questions/templates/budget/question_presentation.jinja

@@ -1,7 +0,0 @@
-{{question_text}}
-The options are 
-{% for option in question_options %}
-{{ loop.index0 }}: {{option}}
-{% endfor %}                       
-Allocate your budget of {{budget_sum}} among the options. 
-

edsl/questions/templates/checkbox/answering_instructions.jinja

@@ -1,10 +0,0 @@
-{# Answering Instructions #}
-{% if use_code %}
-Please respond only with a comma-separated list of the code of the options that apply, with square brackets. E.g., [0, 1, 3]
-{% else %}
-Please respond only with a comma-separated list of the options that apply, with square brackets. E.g., ['Good', 'Bad', 'Ugly']
-{% endif %}
-{% if include_comment %}
-After the answer, you can put a comment explaining your choice on the next line.
-{% endif %}
-

edsl/questions/templates/checkbox/question_presentation.jinja

@@ -1,22 +0,0 @@
-{{question_text}}
-{% if use_code %}
-    {% for option in question_options %}
-{{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-{{ option }}
-    {% endfor %}    
-{% endif %}
-
-{# Restrictions #}
-{% if min_selections != None and max_selections != None and min_selections == max_selections %}
-You must select exactly {{min_selections}} options.
-{% elif min_selections != None and max_selections != None %}
-Minimum number of options that must be selected: {{min_selections}}.
-Maximum number of options that must be selected: {{max_selections}}.
-{% elif min_selections != None %}
-Minimum number of options that must be selected: {{min_selections}}.
-{% elif max_selections != None %}
-Maximum number of options that must be selected: {{max_selections}}.
-{% endif %}

edsl/questions/templates/extract/answering_instructions.jinja

@@ -1,7 +0,0 @@
-An ANSWER should be formatted like this: 
-
-{{ answer_template }}
-
-It should have the same keys but values extracted from the input.
-If the value of a key is not present in the input, fill with "null".
-Put any comments in the next line after the answer.

edsl/questions/templates/extract/question_presentation.jinja

@@ -1 +0,0 @@
-{{question_text}}

edsl/questions/templates/free_text/question_presentation.jinja

@@ -1 +0,0 @@
-{{question_text}}

edsl/questions/templates/likert_five/answering_instructions.jinja

@@ -1,10 +0,0 @@
-{# Answering Instructions #}
-{% if use_code %}
-Respond only with the code corresponding to one of the options.
-{% else %}
-Respond only with a string corresponding to one of the options.
-{% endif %}
-{% if include_comment %}
-After the answer, you can put a comment explaining why you chose that option on the next line.
-{% endif %}
-

edsl/questions/templates/likert_five/question_presentation.jinja

@@ -1,12 +0,0 @@
-{# Question Presention #}
-{{question_text}}
-{% if use_code %}
-    {%- for option in question_options %}
-{{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-{{option}}
-    {% endfor %}
-{% endif %}
-Only 1 option may be selected.

edsl/questions/templates/linear_scale/answering_instructions.jinja

@@ -1,5 +0,0 @@
-{# Answering Instructions #}
-Respond only with the code corresponding to one of the options. E.g., "1" or "5" by itself.
-{% if include_comment %}
-After the answer, you can put a comment explaining why you chose that option on the next line.
-{% endif %}

edsl/questions/templates/linear_scale/question_presentation.jinja

@@ -1,5 +0,0 @@
-{{question_text}}
-{% for option in question_options %}
-{{option}} : {{ option_labels.get(option, "") }}
-{% endfor %}
-Only 1 option may be selected.

edsl/questions/templates/list/answering_instructions.jinja

@@ -1,4 +0,0 @@
-Return your answers on one line, in a comma-separated list of your responses, with square brackets and each answer in quotes E.g., ["A", "B", "C"]
-{% if include_comment %}
-After the answers, you can put a comment explaining your choice on the next line.
-{% endif %}

edsl/questions/templates/list/question_presentation.jinja

@@ -1,5 +0,0 @@
-{{question_text}}
-
-{% if max_list_items is not none %}
-The list must not contain more than {{ max_list_items }} items.
-{% endif %}

edsl/questions/templates/multiple_choice/answering_instructions.jinja

@@ -1,9 +0,0 @@
-{# Answering Instructions #}
-{% if use_code %}
-Respond only with the code corresponding to one of the options.
-{% else %}
-Respond only with a string corresponding to one of the options.
-{% endif %}
-{% if include_comment %}
-After the answer, you can put a comment explaining why you chose that option on the next line.
-{% endif %}

edsl/questions/templates/multiple_choice/question_presentation.jinja

@@ -1,12 +0,0 @@
-{# Question Presention #}
-{{question_text}}
-{% if use_code %}
-    {%- for option in question_options %}
-{{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-{{option}}
-    {% endfor %}
-{% endif %}
-Only 1 option may be selected.

edsl/questions/templates/numerical/answering_instructions.jinja

@@ -1,8 +0,0 @@
-This question requires a numerical response in the form of an integer or decimal (e.g., -12, 0, 1, 2, 3.45, ...).
-Respond with just your number on a single line.
-If your response is equivalent to zero, report '0'
-If you cannot determine the answer, report 'None'
-
-{% if include_comment %}
-After the answer, put a comment explaining your choice on the next line.
-{% endif %}

edsl/questions/templates/numerical/question_presentation.jinja

@@ -1,7 +0,0 @@
-{{question_text}}
-{% if min_value is not none %}
-    Minimum answer value: {{min_value}}
-{% endif %}
-{% if max_value is not none %}
-    Maximum answer value: {{max_value}}
-{% endif %}

edsl/questions/templates/rank/answering_instructions.jinja

@@ -1,11 +0,0 @@
-{# Answering Instructions #}
-{% if use_code %}
-Please respond only with a comma-separated list of the code of the raked options, with square brackets. E.g., [0, 1, 3]
-{% else %}
-Please respond only with a comma-separated list of the ranked options, with square brackets. E.g., ['Good', 'Bad', 'Ugly']
-{% endif %}
-{% if include_comment %}
-After the answer, you can put a comment explaining your choice on the next line.
-{% endif %}
-
-

edsl/questions/templates/rank/question_presentation.jinja

@@ -1,15 +0,0 @@
-{{question_text}}
-{% if use_code %}
-The options are
-{% for option in question_options %}
-{{ loop.index0 }}: {{option}}
-{% endfor %}
-{% else %}
-The options are:
-{% for option in question_options %}
-{{option}}
-{% endfor %}
-{% endif %}
-{% if num_selections %}
-You can inlcude up to {{num_selections}} options in your answer.
-{% endif %}

edsl/questions/templates/top_k/answering_instructions.jinja

@@ -1,8 +0,0 @@
-{# Answering Instructions #}
-Please respond with valid JSON, formatted like so:
-{% if include_comment %}
-    {"answer": [<put comma-separated list here>], "comment": "<put explanation here>"}
-{% else %}
-    {"answer": [<put comma-separated list here>]}
-{% endif %}
-

edsl/questions/templates/top_k/question_presentation.jinja

@@ -1,22 +0,0 @@
-{{question_text}}
-{% if use_code %}
-    {% for option in question_options %}
-{{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-{{ option }}
-    {% endfor %}    
-{% endif %}
-
-{# Restrictions #}
-{% if min_selections != None and max_selections != None and min_selections == max_selections %}
-You must select exactly {{min_selections}} options.
-{% elif min_selections != None and max_selections != None %}
-Minimum number of options that must be selected: {{min_selections}}.
-Maximum number of options that must be selected: {{max_selections}}.
-{% elif min_selections != None %}
-Minimum number of options that must be selected: {{min_selections}}.
-{% elif max_selections != None %}
-Maximum number of options that must be selected: {{max_selections}}.
-{% endif %}

edsl/questions/templates/yes_no/answering_instructions.jinja

@@ -1,6 +0,0 @@
-{# Answering Instructions #}
-Please reponse with just your answer. 
-
-{% if include_comment %}
-After the answer, you can put a comment explaining your reponse.
-{% endif %}

edsl/questions/templates/yes_no/question_presentation.jinja

@@ -1,12 +0,0 @@
-{# Question Presention #}
-{{question_text}}
-{% if use_code %}
-    {%- for option in question_options %}
-{{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-{{option}}
-    {% endfor %}
-{% endif %}
-Only 1 option may be selected.