themefinder 0.5.4__tar.gz → 0.6.3__tar.gz

{themefinder-0.5.4 → themefinder-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: themefinder
-Version: 0.5.4
+Version: 0.6.3
 Summary: A topic modelling Python package designed for analysing one-to-many question-answer data eg free-text survey responses.
 License: MIT
 Author: i.AI
@@ -49,9 +49,9 @@ ThemeFinder takes as input a [pandas DataFrame](https://pandas.pydata.org/docs/r
 - `response_id`: A unique identifier for each response
 - `response`: The free text survey response
 
-ThemeFinder is compatible with any instantiated [LangChain LLM runnable](https://python.langchain.com/v0.1/docs/integrations/llms/), but you will need to use JSON structured output.
+ThemeFinder now supports a range of language models through structured outputs.
 
-The function `find_themes` identifies common themes in response and labels them, it also outputs results from intermediate steps in the theme finding pipeline.
+The function `find_themes` identifies common themes in responses and labels them, it also outputs results from intermediate steps in the theme finding pipeline.
 
 For this example, import the following Python packages into your virtual environment: `asyncio`, `pandas`, `lanchain`. And import `themefinder` as described above.
 
@@ -81,7 +81,6 @@ load_dotenv()
 llm = AzureChatOpenAI(
     model="gpt-4o",
     temperature=0,
-    model_kwargs={"response_format": {"type": "json_object"}},
 )
 
 # Set up your data
@@ -97,18 +96,15 @@ question = "What do you think of ThemeFinder?"
 # Make the system prompt specific to your use case 
 system_prompt = "You are an AI evaluation tool analyzing survey responses about a Python package."
 
-# Run the function to find themes
-# We use asyncio to query LLM endpoints asynchronously, so we need to await our function
+# Run the function to find themes, we use asyncio to query LLM endpoints asynchronously, so we need to await our function
 async def main():
-    result = await find_themes(responses_df, llm, question, system_prompt)
+    result = await find_themes(responses_df, llm, question, system_prompt=system_prompt)
     print(result)
 
 if __name__ == "__main__":
     asyncio.run(main())
-
 ```
 
-
 ## ThemeFinder pipeline
 
 ThemeFinder's pipeline consists of five distinct stages, each utilizing a specialized LLM prompt:
@@ -145,6 +141,25 @@ The file `src/themefinder.core.py` contains the function `find_themes` which run
 **For more detail - see the docs: [https://i-dot-ai.github.io/themefinder/](https://i-dot-ai.github.io/themefinder/).**
 
 
+## Model Compatibility
+
+ThemeFinder's structured output approach makes it compatible with a wide range of language models from various providers. This list is non-exhaustive, and other models may also work effectively:
+
+### OpenAI Models
+- GPT-4, GPT-4o, GPT-4.1
+- All Azure OpenAI deployments
+
+### Google Models
+- Gemini series (1.5 Pro, 2.0 Pro, etc.)
+
+### Anthropic Models
+- Claude series (Claude 3 Opus, Sonnet, Haiku, etc.)
+
+### Open Source Models
+- Llama 2, Llama 3
+- Mistral models (e.g., Mistral 7B, Mixtral)
+
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -155,3 +170,4 @@ The documentation is [© Crown copyright](https://www.nationalarchives.gov.uk/in
 ## Feedback
 
 If you have feedback on this package, please fill in our [feedback form](https://forms.gle/85xUSMvxGzSSKQ499) or contact us with questions or feedback at packages@cabinetoffice.gov.uk.
+

{themefinder-0.5.4 → themefinder-0.6.3}/README.md

@@ -18,9 +18,9 @@ ThemeFinder takes as input a [pandas DataFrame](https://pandas.pydata.org/docs/r
 - `response_id`: A unique identifier for each response
 - `response`: The free text survey response
 
-ThemeFinder is compatible with any instantiated [LangChain LLM runnable](https://python.langchain.com/v0.1/docs/integrations/llms/), but you will need to use JSON structured output.
+ThemeFinder now supports a range of language models through structured outputs.
 
-The function `find_themes` identifies common themes in response and labels them, it also outputs results from intermediate steps in the theme finding pipeline.
+The function `find_themes` identifies common themes in responses and labels them, it also outputs results from intermediate steps in the theme finding pipeline.
 
 For this example, import the following Python packages into your virtual environment: `asyncio`, `pandas`, `lanchain`. And import `themefinder` as described above.
 
@@ -50,7 +50,6 @@ load_dotenv()
 llm = AzureChatOpenAI(
     model="gpt-4o",
     temperature=0,
-    model_kwargs={"response_format": {"type": "json_object"}},
 )
 
 # Set up your data
@@ -66,18 +65,15 @@ question = "What do you think of ThemeFinder?"
 # Make the system prompt specific to your use case 
 system_prompt = "You are an AI evaluation tool analyzing survey responses about a Python package."
 
-# Run the function to find themes
-# We use asyncio to query LLM endpoints asynchronously, so we need to await our function
+# Run the function to find themes, we use asyncio to query LLM endpoints asynchronously, so we need to await our function
 async def main():
-    result = await find_themes(responses_df, llm, question, system_prompt)
+    result = await find_themes(responses_df, llm, question, system_prompt=system_prompt)
     print(result)
 
 if __name__ == "__main__":
     asyncio.run(main())
-
 ```
 
-
 ## ThemeFinder pipeline
 
 ThemeFinder's pipeline consists of five distinct stages, each utilizing a specialized LLM prompt:
@@ -114,6 +110,25 @@ The file `src/themefinder.core.py` contains the function `find_themes` which run
 **For more detail - see the docs: [https://i-dot-ai.github.io/themefinder/](https://i-dot-ai.github.io/themefinder/).**
 
 
+## Model Compatibility
+
+ThemeFinder's structured output approach makes it compatible with a wide range of language models from various providers. This list is non-exhaustive, and other models may also work effectively:
+
+### OpenAI Models
+- GPT-4, GPT-4o, GPT-4.1
+- All Azure OpenAI deployments
+
+### Google Models
+- Gemini series (1.5 Pro, 2.0 Pro, etc.)
+
+### Anthropic Models
+- Claude series (Claude 3 Opus, Sonnet, Haiku, etc.)
+
+### Open Source Models
+- Llama 2, Llama 3
+- Mistral models (e.g., Mistral 7B, Mixtral)
+
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -123,4 +138,4 @@ The documentation is [© Crown copyright](https://www.nationalarchives.gov.uk/in
 
 ## Feedback
 
-If you have feedback on this package, please fill in our [feedback form](https://forms.gle/85xUSMvxGzSSKQ499) or contact us with questions or feedback at packages@cabinetoffice.gov.uk.
+If you have feedback on this package, please fill in our [feedback form](https://forms.gle/85xUSMvxGzSSKQ499) or contact us with questions or feedback at packages@cabinetoffice.gov.uk.

{themefinder-0.5.4 → themefinder-0.6.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "themefinder"
-version = "0.5.4"
+version = "0.6.3"
 description = "A topic modelling Python package designed for analysing one-to-many question-answer data eg free-text survey responses."
 authors = ["i.AI <packages@cabinetoffice.gov.uk>"]
 packages = [{include = "themefinder", from = "src"}]

{themefinder-0.5.4 → themefinder-0.6.3}/src/themefinder/__init__.py

@@ -1,10 +1,12 @@
 from .core import (
     find_themes,
     sentiment_analysis,
-    theme_generation,
     theme_condensation,
-    theme_refinement,
+    theme_generation,
     theme_mapping,
+    theme_refinement,
+    theme_target_alignment,
+    detail_detection,
 )
 
 __all__ = [
@@ -13,6 +15,8 @@ __all__ = [
     "theme_generation",
     "theme_condensation",
     "theme_refinement",
+    "theme_target_alignment",
     "theme_mapping",
+    "detail_detection",
 ]
 __version__ = "0.1.0"