sdg-hub 0.1.4__py3-none-any.whl → 0.2.1__py3-none-any.whl

sdg_hub/configs/knowledge/generate_questions.yaml

@@ -1,82 +0,0 @@
-# This YAML file defines a prompt template for generating educational Q&A pairs from textbook content.
-# The prompt is designed to create comprehensive, domain-specific questions and answers that
-# effectively teach and reinforce key concepts from educational materials.
-#
-# Structure:
-# - system: Sets the AI's role as a knowledgeable assistant
-# - introduction: Main instruction for creating Q&A pairs from textbook chapters
-# - principles: Detailed guidelines for question formulation and educational value
-# - examples: Example Q&A pairs showing expected format and style
-# - generation: Template for the document to be used for Q&A generation
-#
-# Key Features:
-# - Domain-specific question generation (science, legal, etc.)
-# - Multiple difficulty levels and question types
-# - Self-contained questions without external references
-# - Focus on key concepts and learning objectives
-# - Educational value and teaching effectiveness
-#
-# Question Guidelines:
-# - Must be self-contained and independently answerable
-# - Should cover basic recall to advanced comprehension
-# - Include multiple-choice, short answer, and essay types
-# - Align with chapter learning objectives
-# - Avoid references to specific sections or figures
-#
-# Response Format:
-# - Questions and answers are clearly separated
-# - Each response ends with [End] tag
-# - [UNANSWERABLE] for unsuitable content
-#
-# Usage:
-# This prompt is used to generate educational Q&A pairs that effectively teach
-# and reinforce concepts from textbook chapters while maintaining educational
-# value and accessibility.
-
-system: You are a very knowledgeable AI Assistant that will faithfully assist the user with their task.
-
-introduction: Develop a series of educational questions from a chapter in a {{domain}} textbook. 
-
-principles: |
-  The questions should:
-  * Self-contained – understandable without needing to reference tables, figures, or specific text sections.
-  * Focus on the provided example and follow the format and style of the provided examples.
-  * Relevant to the subject – based on the textbook’s domain (e.g., legal, scientific, etc.).
-  * Independently answerable – avoid direct references to theorems, figures, or text numbers.
-  * Varied in difficulty - Make difficult same as the provided examples.
-  * Use same format as the provided examples.
-
-  Strictly follow this format for each question your generate while responding
-
-  [QUESTION]
-  <Insert question here>
-  [END]
-
-
-examples: |
-  Here are some examples of questions:
-
-  [Document]
-  {{icl_document}}
-
-  [QUESTION]
-  {{icl_query_1}}
-  [END]
-
-  [QUESTION]
-  {{icl_query_2}}
-  [END]
-
-  [QUESTION]
-  {{icl_query_3}}
-  [END]
-
-generation: |
-  Here is the document:
-  
-  [DOCUMENT]
-  {{document_outline}}
-  {{document}}
-
-start_tags: [""]
-end_tags: [""]

sdg_hub/configs/knowledge/generate_questions_responses.yaml

@@ -1,56 +0,0 @@
-system: You are a very knowledgeable AI Assistant that will faithfully assist the user with their task.
-
-introduction: Develop a series of educational question and answer pairs from a chapter in a {{domain}} textbook. 
-
-principles: |
-  The questions should:
-  * Be self-contained, not requiring references to tables, figures, or specific sections in the text for understanding.
-  * Focus on teaching and reinforcing the key knowledge and concepts presented in the chapter.
-  * Avoid sections with minimal educational content like index pages or prefaces. In such cases, respond with [UNANSWERABLE].
-  * Be directly relevant to the textbook's domain. For instance, in a science textbook, questions should revolve around scientific terms, definitions, and practical applications, while in a legal textbook, they should cover legal principles, case law, and precedents.
-  * Be formulated to allow for independent answers, avoiding direct references to specific theorems or text sections. For example, rather than asking 'Under what conditions is the fixed point of a function unique according to Theorem 3.1.5?', ask 'How does the Fixed Point Iteration method contribute to understanding function uniqueness?'
-  * Span a range of difficulty levels to accommodate a diverse student audience, from basic understanding to advanced comprehension.
-  * Include a variety of question types such as multiple-choice for basic recall, short answer for deeper understanding, and essay or problem-solving questions to test application and analysis skills.
-  * Align closely with the learning objectives of the textbook or the specific chapter, ensuring that the questions test the fundamental concepts and skills that the chapter aims to impart.
-
-  Strictly follow this format for each question answer pair your generate while responding
-
-  [QUESTION]
-  <Insert question here>
-  [ANSWER]
-  <Insert answer here>
-  [END]
-
-
-  Each question and answer pair should stand alone as a mini-lesson, encapsulating a key concept or idea from the chapter in a way that is accessible and informative without requiring the reader to refer back to the textbook.
-
-examples: |
-  Here are some examples of questions:
-
-  [Document]
-  {{icl_document}}
-
-  [QUESTION]
-  {{icl_query_1}}
-  [ANSWER]
-  {{icl_response_1}}
-  [END]
-
-  [QUESTION]
-  {{icl_query_2}}
-  [ANSWER]
-  {{icl_response_2}}
-  [END]
-
-  [QUESTION]
-  {{icl_query_3}}
-  [ANSWER]
-  {{icl_response_3}}
-  [END]
-
-generation: |
-  Here is the document:
-  
-  [DOCUMENT]
-  {{document_outline}}
-  {{document}}

sdg_hub/configs/knowledge/generate_responses.yaml

@@ -1,86 +0,0 @@
-# This YAML file defines a prompt template for generating educational Q&A pairs from textbook content.
-# The prompt is designed to create comprehensive, domain-specific questions and answers that
-# effectively teach and reinforce key concepts from educational materials.
-#
-# Structure:
-# - system: Sets the AI's role as a knowledgeable assistant
-# - introduction: Main instruction for creating Q&A pairs from textbook chapters
-# - principles: Detailed guidelines for question formulation and educational value
-# - examples: Example Q&A pairs showing expected format and style
-# - generation: Template for the document to be used for Q&A generation
-#
-# Key Features:
-# - Domain-specific question generation (science, legal, etc.)
-# - Multiple difficulty levels and question types
-# - Self-contained questions without external references
-# - Focus on key concepts and learning objectives
-# - Educational value and teaching effectiveness
-#
-# Question Guidelines:
-# - Must be self-contained and independently answerable
-# - Should cover basic recall to advanced comprehension
-# - Include multiple-choice, short answer, and essay types
-# - Align with chapter learning objectives
-# - Avoid references to specific sections or figures
-#
-# Response Format:
-# - Questions and answers are clearly separated
-# - Each response ends with [End] tag
-# - [UNANSWERABLE] for unsuitable content
-#
-# Usage:
-# This prompt is used to generate educational Q&A pairs that effectively teach
-# and reinforce concepts from textbook chapters while maintaining educational
-# value and accessibility.
-
-system: You are a very knowledgeable AI Assistant that will faithfully assist the user with their task.
-
-introduction: Answer the question based on the provided document.  
-
-principles: |
-  The answers should:
-  * The answer is grounded in the provided document.
-  * Follows the format and style of the provided examples.
-  * Directly answers the question.
-  Strictly follow this format for each question your generate while responding
-
-  [ANSWER]
-  <Insert answer here>
-  [END]
-
-
-examples: |
-  Here are some examples of answers for given questions for a document:
-
-  [Document]
-  {{icl_document}}
-
-  [QUESTION]
-  {{icl_query_1}}
-
-  [ANSWER]
-  {{icl_response_1}}
-  [END]
-
-  [QUESTION]
-  {{icl_query_2}}
-
-  [ANSWER]
-  {{icl_response_2}}
-  [END]
-
-
-generation: |
-  Here is the document:
-  
-  [DOCUMENT]
-  {{document_outline}}
-  {{document}}
-
-  [QUESTION]
-  {{question}}
-
-  [ANSWER]
-
-start_tags: [""]
-end_tags: [""]

sdg_hub/configs/knowledge/mcq_generation.yaml

@@ -1,83 +0,0 @@
-system: You are a helpful assistant, that is an expert at generating question and answers based on given guidelines.
-
-introduction: Create a series of multiple choice questions by following the given guidelines
-
-principles: |
-  Guidelines for generation:
-  * Create Multiple Choice Questions based on the data presented in the documents provided.
-  * Each question should be accompanied by a correct answer that accurately interprets the data.
-  * Ensure that the question and the answer are grounded in the provided document.
-  * Return the question between the [Start of Question] and [End of Question] tags.
-  * Return the answer within the [Start of Answer] and [End of Answer] tags.
-
-  Follow this structure for each example:
-
-  [Start of Document]
-  The boiling point of water is the temperature at which it changes from liquid to gas. This occurs at 100 degrees Celsius under standard atmospheric pressure.
-  [End of Document]
-
-  [Start of Question]
-  What does the boiling point of water represent?
-
-  A) Solidification
-  B) Evaporation
-  C) Condensation
-  D) Freezing
-  [End of Question]
-
-  [Start of Answer]
-  B) Evaporation
-  [End of Answer]
-
-examples: |
-  
-  Example 1:
-  [Start of Document]
-  Photosynthesis is a process used by plants, algae, and certain bacteria to convert light energy into chemical energy. This process involves the absorption of light by chlorophyll, conversion of inorganic carbon dioxide (CO2) into organic compounds, and release of oxygen (O2) as a byproduct. The general equation for photosynthesis can be represented as
-  6CO2 + 6H2O + light energy → C6H12O6 + 6O2.
-  [Start of Document]
-
-  [Start of Question]
-  What is the primary function of photosynthesis in plants?
-
-  A) To produce carbon dioxide
-  B) To convert light energy into chemical energy
-  C) To absorb oxygen from the atmosphere
-  D) To release carbon dioxide into the environment
-  [End of Question]
-
-  [Start of Answer]
-  B) To convert light energy into chemical energy
-  [End of Answer]
-
-  Example 2:
-  [Start of Document]
-  E-commerce, short for electronic commerce, refers to the buying and selling of goods and services over the Internet. It encompasses a variety of transactions, including B2B (business to business), B2C (business to consumer), and C2C (consumer to consumer). E-commerce platforms can be purely digital or may combine online and physical operations.
-  [End of Document]
-
-  [Start of Question]
-  E-commerce primarily involves what kind of transactions?
-
-  A) Digital
-  B) Local
-  C) Manual
-  D) Verbal
-  [End of Question]
-
-  [Start of Answer]
-  A) Digital
-  [End of Answer]
-
-generation: |
-  Follow the guidelines and structure given above to create series of Multiple choice question, along with correct answers, based on the provided document. 
-  * Return the question between the [Start of Question] and [End of Question] tags.
-  * Return the answer within the [Start of Answer] and [End of Answer] tags.
-
-  Here is the document:
-  [Start of Document]
-  {{document_outline}}
-  {{document}}
-  [End of Document]
-
-start_tags: ["[Start of Question]", "[Start of Answer]"]
-end_tags: ["[End of Question]", "[End of Answer]"]

sdg_hub/configs/knowledge/router.yaml

@@ -1,12 +0,0 @@
-system: ""
-
-introduction: ""
-
-principles: ""
-
-examples: ""
-
-generation: "{{document}}"
-
-start_tags: [""]
-end_tags: [""]

sdg_hub/configs/knowledge/simple_generate_qa.yaml

@@ -1,34 +0,0 @@
-system: You are a very knowledgeable AI Assistant that will faithfully assist the user with their task.
-
-introduction: Develop a series of educational question and answer pairs from a chapter in a {{domain}} textbook.
-
-principles: |
-  Here are the requirements:
-  1. Try not to repeat the verb for each instruction to maximize diversity.
-  2. The language used for the instruction also should be diverse. For example, you should combine questions with imperative instructions.
-  3. The type of instructions should be similar to provided examples. The generated instruction and the output should be grounded in the provided document.
-  4. A GPT language model should be able to complete the instruction. For example, do not ask the assistant to create any visual or audio output. For another example, do not ask the assistant to wake you up at 5pm or set a reminder because it cannot perform any action.
-  5. The instructions should be in English.
-  6. The instructions should be 1 to 2 sentences long. Either an imperative sentence or a question is permitted.
-  7. The output should be an appropriate response to the input and the instruction. Long outputs are preferable.
-
-examples: |
-  Here are some examples to help you understand the type of questions that are asked for this document:
-
-  {{icl_query_1}}
-  {{icl_response_1}}
-
-  {{icl_query_2}}
-  {{icl_response_2}}
-
-  {{icl_query_3}}
-  {{icl_response_3}}
-
-  Here is the document:
-  {{document}}
-
-generation: |
-  Provide a single question and answer pair based on the document.
-
-start_tags: [""]
-end_tags: [""]

sdg_hub/configs/reasoning/dynamic_cot.yaml

@@ -1,40 +0,0 @@
-system: You are an AI assistant that uses dynamic Chain of Thought (CoT), reflection, and verbal reinforcement learning for problem-solving. Your responses must adhere to the following instructions
-
-principles: |
-  1. Break down the solution into clear steps, providing a descriptive title and content for each step to ensure logical progression.
-  2. Adjust your reasoning dynamically based on intermediate results and reflections, adapting your strategy as needed.
-  3. Regularly evaluate your progress, being critical and honest about your reasoning. After every three steps, perform a detailed self-reflection to identify potential biases and consider alternative strategies.
-  4. For mathematical problems, show all work explicitly using LaTeX notation and provide detailed proofs.
-  5. Explore multiple solutions individually when possible, comparing approaches during reflections.
-  6. Use a scratchpad to document calculations, reasoning, and any intermediate thoughts explicitly.
-  7. Stay aware of your limitations as an AI, clearly communicating what you can and cannot do.
-
-examples: |
-  Respond in JSON format, with each response containing the following keys:
-      - current_action: Indicates the current action being taken, chosen from:
-          * think: Engage in thoughtful planning about how to approach or solve the task, considering potential strategies and identifying crucial elements.
-          * reflect: Pause to evaluate and reconsider your reasoning, assessing potential biases or errors.
-          * backtrack: Revert to a previous step and try a different solution path.
-          * generate: Present the final answer if confident.
-          * terminate: Conclude the process if no further action is needed.
-      - title: Describes the focus of the current step.
-      - content: Provides a detailed explanation of the step. 
-      - confidence: A number between 0 and 1 representing your confidence in the content produced for the current action.
-      - next_action: Suggests the next action to be taken, chosen from the same set of actions.
-
-  Example of a valid JSON response:
-  ```json
-  {
-      "current_action": "think",
-      "title": "Identifying Key Information",
-      "content": "To begin solving this problem, we need to carefully examine the given information and identify the crucial elements that will guide our solution process. This involves...",
-      "confidence": 0.8,
-      "next_action": "reflect"
-  }
-  ```
-
-generation: |
-  Your goal is to demonstrate a thorough, adaptive, and self-reflective problem-solving process, emphasizing dynamic thinking and learning from your reasoning.
-
-
-

sdg_hub/configs/skills/analyzer.yaml

@@ -1,48 +0,0 @@
-system: You are a very knowledgeable AI Assistant that will faithfully assist the user with their task.
-
-introduction: | 
-  You will assume the role of an question analyzer. Given an user question your task is to analyze the question and generate an analysis including the domain of the task, a brief description of the task, and 5 domain specific rubric to evaluate the response. 
-
-principles: |
-  1. Analysis: 
-      * Briefly describe the task of the question, identify the domain of the task, and provide a clear understanding of the user's request.
-      * Look for any keywords or phrases that indicate the user's specific requirements when it comes to the format or type of response.
-      * The analysis should be clear, concise and unambiguous.
-      * Return the analysis between [Start of Analysis] and [End of Analysis] tags.
-
-  2. Rubric: 
-      * Generate 3 to 5 domain specific rubric to evaluate the response.
-      * The generated rubric should be clear, concise and unambiguous.
-      * The rubric should be specific to the domain of the question and should not be generic.
-      * The rubric should be actionable and feasible.
-      * The rubric should satisfy all the criteria provided in the question. For instance, input and output format, type of response, etc.
-      * Return the rubric between [Start of Rubric] and [End of Rubric] tags.
-
-  As a general guideline, generate all the required information without any explanation or reasoning. 
-
-examples: |
-  To help you understand the task, here is an example:
-
-  [Start of Question]
-  {{ icl_query }}
-  [End of Question]
-
-  [Start of Analysis]
-  {{ icl_analysis }}
-  [End of Analysis]
-
-  [Start of Rubric]
-  {{ icl_rubric }}
-  [End of Rubric]
-
-generation: |
-  Now it's your turn to analyze the following question. Remember to follow the paradigm and return the analysis and rubric in the respective sections. Strictly format the response using the specified tags.
-  * Return the analysis between [Start of Analysis] and [End of Analysis] tags.
-  * Return the rubric between [Start of Rubric] and [End of Rubric] tags.
-
-  [Start of Question]
-  {{ question }}
-  [End of Question]
-
-start_tags: ["[Start of Analysis]", "[Start of Rubric]"]
-end_tags: ["[End of Analysis]", "[End of Rubric]"]

sdg_hub/configs/skills/annotation.yaml

@@ -1,36 +0,0 @@
-system: |
-  {{ system }}
-introduction: |
-  {{ task_description }}
-principles: |
-  {{ principles }}
-examples: |
-  To better assist you with this task, here are some examples:
-  {% if seed_samples is defined %}
-  {% for sample in seed_samples %}
-  [Start of Question]
-  {{ sample.seed_question }}
-  [End of Question]
-
-  [Start of Response]
-  {{ sample.seed_response }}
-  [End of Response]
-  {% endfor %}
-  {% else %}
-  [Start of Question]
-  {{ seed_question }}
-  [End of Question]
-
-  [Start of Response]
-  {{ seed_response }}
-  [End of Response]
-  {% endif %}
-generation: |
-  Remember to follow the principles mentioned above and use the same format as the examples. 
-  [Start of Question]
-  {{ question }}
-  [End of Question]
-
-  Generate the response to the question above and return it in between the [Start of Response] and [End of Response] tags.
-start_tags: ["[Start of Response]"]
-end_tags: ["[End of Response]"]

sdg_hub/configs/skills/contexts.yaml

@@ -1,28 +0,0 @@
-system: You are a highly capable AI Assistant that specializes in generating high-quality content tailored to specific tasks.
-
-introduction: |
-  Your task is to write a rich, relevant, and well-structured **context** for the following task:
-  Task Description: {{task_description}}
-
-principles: |
-  Please follow these guiding principles when generating the context:
-  * The context should be coherent, informative, and closely aligned with the task description.
-  * Do not include any greetings, explanations, or meta commentary.
-  * Maintain a natural, human-like tone suitable for the domain.
-  * Follow the formatting shown in the example exactly.
-  * Wrap the output between the tags: [Start of Context] and [End of Context].
-
-examples: |
-  To guide you, here is an example of a well-structured context:
-  
-  [Start of Context]
-  {{seed_context}}
-  [End of Context]
-
-generation: |
-  Now generate a new context following the same structure and principles. 
-  Begin your output with [Start of Context] and end with [End of Context]. 
-  Do not include any additional text outside these tags.
-
-start_tags: ["[Start of Context]"]
-end_tags: ["[End of Context]"]

sdg_hub/configs/skills/critic.yaml

@@ -1,60 +0,0 @@
-system: | 
-  You are a very knowledgeable AI Assistant that will faithfully assist the user with their task.
-
-introduction: | 
-  You will assume the role of a critic. You will be given an analysis of a query which includes a rubric, and a response to the query generated by an AI assistant. Your task is to evaluate the response based on the rubric provided. 
-
-principles: |
-  Use the following step-by-step process to evaluate the response:
-    * Using the domain as a part of the analysis, assume the role of an expert in that domain.
-    * Understand the task description provided in the analysis.
-    * Using the Rubric provided, evaluate the response generated by the AI assistant.
-    * For each item in the rubric, your evaluation should include how well the response meets the criteria and any feedback for improvement.
-    * Only evaluate the response based on the rubric provided, do not create your own criteria.
-
-examples: |
-  To help you understand the task, here is an example: 
-
-  [Start of Query]
-  {{ icl_query }}
-  [End of Query]
-
-  [Start of Response]
-  {{ icl_response }}
-  [End of Response]
-
-  [Start of Analysis]
-  {{ icl_analysis }}
-  [End of Analysis]
-
-  [Start of Rubric]
-  {{ icl_rubric }}
-  [End of Rubric]
-
-  [Start of Critique]
-  {{ icl_critique }}
-  [End of Critique]
-
-generation: |
-  Now it's your turn to analyze the following query. 
-
-  [Start of Query]
-  {{ question }}
-  [End of Query]
-
-  [Start of Response]
-  {{ response }}
-  [End of Response]
-
-  [Start of Analysis]
-  {{ analysis }}
-  [End of Analysis]
-
-  [Start of Rubric]
-  {{ rubric }}
-  [End of Rubric]
-
-  Remember to follow the paradigm and return the critique based on the rubric provided, between [Start of Critique] and [End of Critique] tags.
-
-start_tags: ["[Start of Critique]"]
-end_tags: ["[End of Critique]"]