edsl 0.1.37.dev6__py3-none-any.whl → 0.1.38__py3-none-any.whl

edsl/questions/prompt_templates/question_budget.jinja

@@ -1,13 +1,13 @@
-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).
+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 +1,32 @@
-{# 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 %}
-
+{# 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 +1,11 @@
-{{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.
+{{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 +1,3 @@
-{{question_text}}
-Return a valid JSON formatted like this: 
-{"answer": "<put free text answer here>"}
+{{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 +1,11 @@
-    {{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.
+    {{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 +1,17 @@
-{{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 %}
+{{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 +1,33 @@
-{# 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 %}
+{# 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 +1,37 @@
-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}}
+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/question_registry.py

@@ -1,147 +1,177 @@
-"""This module provides a factory class for creating question objects."""
-
-import textwrap
-from uuid import UUID
-from typing import Any, Optional, Union
-
-
-from edsl.questions.QuestionBase import RegisterQuestionsMeta
-
-
-class Meta(type):
-    """Metaclass for QuestionBase that provides a __repr__ method that lists all available questions."""
-
-    def __repr__(cls):
-        """Return a string that lists all available questions."""
-
-        s = textwrap.dedent(
-            """
-        You can use the Question class to create objects by name. 
-        For example, to create a multiple choice question, you can do:
-
-        >>> from edsl import Question
-        >>> q = Question('multiple_choice', question_text='What is your favorite color?', question_name='color')
-        
-        Question Types:\n"""
-        )
-        for question_type, question_class in cls.available(
-            show_class_names=True
-        ).items():
-            line_info = (
-                f"{question_type} ({question_class.__name__}): {question_class.__doc__}"
-            )
-            s += line_info + "\n"
-        return s
-
-
-class Question(metaclass=Meta):
-    """Factory class for creating question objects."""
-
-    def __new__(cls, question_type, *args, **kwargs):
-        """Create a new question object."""
-        get_question_classes = RegisterQuestionsMeta.question_types_to_classes()
-
-        subclass = get_question_classes.get(question_type, None)
-        if subclass is None:
-            raise ValueError(
-                f"No question registered with question_type {question_type}"
-            )
-
-        # Create an instance of the selected subclass
-        instance = object.__new__(subclass)
-        instance.__init__(*args, **kwargs)
-        return instance
-
-    @classmethod
-    def example(cls, question_type: str):
-        """Return an example question of the given type."""
-        get_question_classes = RegisterQuestionsMeta.question_types_to_classes()
-        q = get_question_classes.get(question_type, None)
-        return q.example()
-
-    @classmethod
-    def pull(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
-        """Pull the object from coop."""
-        from edsl.coop import Coop
-
-        coop = Coop()
-        return coop.get(uuid, url, "question")
-
-    @classmethod
-    def delete(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
-        """Delete the object from coop."""
-        from edsl.coop import Coop
-
-        coop = Coop()
-        return coop.delete(uuid, url)
-
-    @classmethod
-    def patch(
-        cls,
-        uuid: Optional[Union[str, UUID]] = None,
-        url: Optional[str] = None,
-        description: Optional[str] = None,
-        value: Optional[Any] = None,
-        visibility: Optional[str] = None,
-    ):
-        """Patch the object on coop."""
-        from edsl.coop import Coop
-
-        coop = Coop()
-        return coop.patch(uuid, url, description, value, visibility)
-
-    @classmethod
-    def available(cls, show_class_names: bool = False) -> Union[list, dict]:
-        """Return a list of available question types.
-
-        :param show_class_names: If True, return a dictionary of question types to class names. If False, return a set of question types.
-
-        Example usage:
-
-        >>> from edsl import Question
-        >>> Question.available()
-        ['checkbox', 'extract', 'free_text', 'functional', 'likert_five', 'linear_scale', 'list', 'multiple_choice', 'numerical', 'rank', 'top_k', 'yes_no']
-        """
-        exclude = ["budget"]
-        if show_class_names:
-            return RegisterQuestionsMeta.question_types_to_classes()
-        else:
-            question_list = sorted(
-                set(RegisterQuestionsMeta.question_types_to_classes().keys())
-            )
-            return [q for q in question_list if q not in exclude]
-
-
-def get_question_class(question_type):
-    """Return the class for the given question type."""
-    q2c = RegisterQuestionsMeta.question_types_to_classes()
-    if question_type not in q2c:
-        raise ValueError(
-            f"The question type, {question_type}, is not recognized. Recognied types are: {q2c.keys()}"
-        )
-    return q2c.get(question_type)
-
-
-question_purpose = {
-    "multiple_choice": "When options are known and limited",
-    "free_text": "When options are unknown or unlimited",
-    "checkbox": "When multiple options can be selected",
-    "numerical": "When the answer is a single numerical value e.g., a float",
-    "linear_scale": "When options are text, but can be ordered, e.g., daily, weekly, monthly, etc.",
-    "yes_no": "When the question can be fully answered with either a yes or a no",
-    "list": "When the answer should be a list of items",
-    "rank": "When the answer should be a ranked list of items",
-    "budget": "When the answer should be an amount allocated among a set of options",
-    "top_k": "When the answer should be a list of the top k items",
-    "likert_five": "When the answer should be a value on the Likert scale from 1 to 5",
-    "extract": "When the answer should be information extracted or extrapolated from a text in a given format",
-}
-
-
-if __name__ == "__main__":
-    print(Question.available())
-
-    # q = Question("free_text", question_text="How are you doing?", question_name="test")
-    # results = q.run()
-
-    q = Question.pull(id=76)
+"""This module provides a factory class for creating question objects."""
+
+import textwrap
+from uuid import UUID
+from typing import Any, Optional, Union
+
+
+from edsl.questions.QuestionBase import RegisterQuestionsMeta
+
+
+class Meta(type):
+    """Metaclass for QuestionBase that provides a __repr__ method that lists all available questions."""
+
+    def __repr__(cls):
+        """Return a string that lists all available questions."""
+
+        s = textwrap.dedent(
+            """
+        You can use the Question class to create objects by name. 
+        For example, to create a multiple choice question, you can do:
+
+        >>> from edsl import Question
+        >>> q = Question('multiple_choice', question_text='What is your favorite color?', question_name='color')
+        
+        Question Types:\n"""
+        )
+        for question_type, question_class in cls.available(
+            show_class_names=True
+        ).items():
+            line_info = (
+                f"{question_type} ({question_class.__name__}): {question_class.__doc__}"
+            )
+            s += line_info + "\n"
+        return s
+
+
+class Question(metaclass=Meta):
+    """Factory class for creating question objects."""
+
+    def __new__(cls, question_type, *args, **kwargs):
+        """Create a new question object."""
+        get_question_classes = RegisterQuestionsMeta.question_types_to_classes()
+
+        subclass = get_question_classes.get(question_type, None)
+        if subclass is None:
+            raise ValueError(
+                f"No question registered with question_type {question_type}"
+            )
+
+        # Create an instance of the selected subclass
+        instance = object.__new__(subclass)
+        instance.__init__(*args, **kwargs)
+        return instance
+
+    @classmethod
+    def example(cls, question_type: str):
+        """Return an example question of the given type."""
+        get_question_classes = RegisterQuestionsMeta.question_types_to_classes()
+        q = get_question_classes.get(question_type, None)
+        return q.example()
+
+    @classmethod
+    def pull(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
+        """Pull the object from coop."""
+        from edsl.coop import Coop
+
+        coop = Coop()
+        return coop.get(uuid, url, "question")
+
+    @classmethod
+    def delete(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
+        """Delete the object from coop."""
+        from edsl.coop import Coop
+
+        coop = Coop()
+        return coop.delete(uuid, url)
+
+    @classmethod
+    def patch(
+        cls,
+        uuid: Optional[Union[str, UUID]] = None,
+        url: Optional[str] = None,
+        description: Optional[str] = None,
+        value: Optional[Any] = None,
+        visibility: Optional[str] = None,
+    ):
+        """Patch the object on coop."""
+        from edsl.coop import Coop
+
+        coop = Coop()
+        return coop.patch(uuid, url, description, value, visibility)
+
+    @classmethod
+    def list_question_types(cls):
+        """Return a list of available question types.
+
+        >>> from edsl import Question
+        >>> Question.list_question_types()
+        ['checkbox', 'extract', 'free_text', 'functional', 'likert_five', 'linear_scale', 'list', 'multiple_choice', 'numerical', 'rank', 'top_k', 'yes_no']
+        """
+        return [
+            q
+            for q in sorted(
+                list(RegisterQuestionsMeta.question_types_to_classes().keys())
+            )
+            if q not in ["budget"]
+        ]
+
+    @classmethod
+    def available(cls, show_class_names: bool = False) -> Union[list, dict]:
+        """Return a list of available question types.
+
+        :param show_class_names: If True, return a dictionary of question types to class names. If False, return a set of question types.
+
+        Example usage:
+
+        """
+        from edsl.results.Dataset import Dataset
+
+        exclude = ["budget"]
+        if show_class_names:
+            return RegisterQuestionsMeta.question_types_to_classes()
+        else:
+            question_list = [
+                q
+                for q in sorted(
+                    set(RegisterQuestionsMeta.question_types_to_classes().keys())
+                )
+                if q not in exclude
+            ]
+            d = RegisterQuestionsMeta.question_types_to_classes()
+            question_classes = [d[q] for q in question_list]
+            example_questions = [repr(q.example()) for q in question_classes]
+
+            return Dataset(
+                [
+                    {"question_type": [q for q in question_list]},
+                    {"question_class": [q.__name__ for q in question_classes]},
+                    {"example_question": example_questions},
+                ],
+                print_parameters={"containerHeight": "auto"},
+            )
+
+
+def get_question_class(question_type):
+    """Return the class for the given question type."""
+    q2c = RegisterQuestionsMeta.question_types_to_classes()
+    if question_type not in q2c:
+        raise ValueError(
+            f"The question type, {question_type}, is not recognized. Recognied types are: {q2c.keys()}"
+        )
+    return q2c.get(question_type)
+
+
+question_purpose = {
+    "multiple_choice": "When options are known and limited",
+    "free_text": "When options are unknown or unlimited",
+    "checkbox": "When multiple options can be selected",
+    "numerical": "When the answer is a single numerical value e.g., a float",
+    "linear_scale": "When options are text, but can be ordered, e.g., daily, weekly, monthly, etc.",
+    "yes_no": "When the question can be fully answered with either a yes or a no",
+    "list": "When the answer should be a list of items",
+    "rank": "When the answer should be a ranked list of items",
+    "budget": "When the answer should be an amount allocated among a set of options",
+    "top_k": "When the answer should be a list of the top k items",
+    "likert_five": "When the answer should be a value on the Likert scale from 1 to 5",
+    "extract": "When the answer should be information extracted or extrapolated from a text in a given format",
+}
+
+
+if __name__ == "__main__":
+    print(Question.available())
+
+    # q = Question("free_text", question_text="How are you doing?", question_name="test")
+    # results = q.run()
+
+    q = Question.pull(id=76)