v0.0.2 Test release

Author: Wermutton

.github/python-package-version-test.yml renamed to .github/workflows/python-package-version-test.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10"]
 
     steps:
       - uses: actions/checkout@v3

.github/python-publish.yml renamed to .github/workflows/python-publish.yml

@@ -1,18 +1,22 @@
 # LangDiversity
 
-[![PyPI version](https://badge.fury.io/py/diversity-measures.svg)](LINK_TO_PYPI)
+[![PyPI version](https://badge.fury.io/py/langdiversity.svg)](LINK_TO_PYPI)
 [![Python version](https://img.shields.io/badge/python-3.7%2B-blue)](LINK_TO_PYTHON_VERSION)
-[![License](https://img.shields.io/badge/license-MIT-green)](LINK_TO_LICENSE)
+[![License](https://img.shields.io/badge/license-BSD%203--Clause-blue)](LICENSE)
 
 Elevate your language models with insightful diversity metrics.
 
+## Links
+
+Paper: https://arxiv.org/abs/2308.11189
+
+Video: https://www.youtube.com/watch?v=BekDOLm6qBI&t=10s&ab_channel=NeuroSymbolic
+
 ## Table of Contents
 
 - [Introduction](#introduction)
 - [Installation](#installation)
-- [Quick Start](#quick-start)
-- [Documentation](#documentation)
-- [Contributing](#contributing)
+- [Usage](#usage)
 - [Bibtex](#bibtex)
 - [License](#license)
 - [Contacts](#contacts)
@@ -26,47 +30,25 @@ The primary goal of this project is to assist researchers and developers in anal
 ## Installation
 
 ```bash
-pip install diversity-measures
+pip install langdiversity
 ```
 
-## Quick Start
-
-```python
-from langdiversity.models import OpenAIModel
-from langdiversity.measures import ShannonEntropyMeasure
-from langdiversity.utils import PromptSelection
-
-# Initialize the OpenAI model and diversity measure
-model = OpenAIModel(openai_api_key="YOUR_OPENAI_API_KEY")
-diversity_measure = ShannonEntropyMeasure()
-
-# Use the PromptSelection utility
-prompt_selection = PromptSelection(model=model, diversity_measure=diversity_measure)
-selected_prompt, selected_diversity = prompt_selection.generate(["Your list of prompts here..."])
-
-print("Selected Prompt:", selected_prompt)
-print("Selected Diversity:", selected_diversity)
-```
-
-## Documentation
-
-Detailed documentation is available [here]().
-
-## Contributing
+## Usage
 
-We welcome contributions! Please see our [contribution guidelines]() for more details.
+Detailed documentation is available [here](https://github.com/lab-v2/diversity_package/tree/main/docs/langdiversity_library.md).
 
 ## Bibtex
 
 If you used this software in your work please cite our paper
 
 ```bibtex
-@article{ngu2023diversity,
-  title={Diversity Measures: Domain-Independent Proxies for Failure in Language Model Queries},
-  author={Ngu, Noel and Lee, Nathaniel and Shakarian, Paulo},
-  journal={arXiv preprint arXiv:2308.11189},
-  year={2023},
-  url={https://arxiv.org/abs/2308.11189},
+@misc{ngu2023diversity,
+      title={Diversity Measures: Domain-Independent Proxies for Failure in Language Model Queries},
+      author={Noel Ngu and Nathaniel Lee and Paulo Shakarian},
+      year={2023},
+      eprint={2308.11189},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
 }
 ```
 

README.md

@@ -0,0 +1,50 @@
+# LangDiversity Python Library
+
+pypi project: https://pypi.org/project/langdiversity/
+
+## Install
+
+```bash
+pip install langchain
+```
+
+## Usage
+
+Example:
+
+```python
+from langdiversity.models import OpenAIModel
+from langdiversity.measures import ShannonEntropyMeasure
+from langdiversity.utils import PromptSelection
+
+# Initialize the OpenAI model and diversity measure
+model = OpenAIModel(openai_api_key="YOUR_OPENAI_API_KEY")
+diversity_measure = ShannonEntropyMeasure()
+
+# Use the PromptSelection utility
+prompt_selection = PromptSelection(model=model, num_responses=10, diversity_measure=diversity_measure)
+
+# Selects the prompt with the configured diversity measure criteria from the LLM's 10 responses
+selected_prompt, selected_measure = prompt_selection.generate(["Your list of prompts here..."])
+
+print("Selected Prompt:", selected_prompt)
+print("Selected Measure:", selected_measure)
+```
+
+### PromptSelection Paramaters:
+
+- `model`: The language model you want to use. In this example, we're using OpenAI's model.
+
+- `diversity_measure`: The measure of diversity measure you want to use. Here, we're using entropy.
+
+- `num_responses`: The number of responses you want the model to generate for each prompt. Default is 1.
+
+- `selection`: Determines how the best prompt is selected based on its diversity measure. It can be:
+
+  - `"min"`: Selects the prompt with the minimum diversity measure. (default)
+  - `"max"`: Selects the prompt with the maximum diversity measure.
+
+### Output:
+
+- `selected_prompt`: The prompt that meets the specified diversity criteria (either min or max) among the given list of prompts.
+- `selected_measure`: The diversity measure of the `selected_prompt` based on the specified diversity measure (e.g., entropy).

docs/langdiversity_library.md

@@ -44,4 +44,4 @@ def generate(self, prompts: List[str]):
                 {"responses": responses, "diversity": diversity, "prompt": prompt}
             )
 
-        return selected_prompt, selected_diversity, info
+        return selected_prompt, selected_diversity

langdiversity/utils/prompt_selection.py

@@ -1,13 +1,20 @@
 from setuptools import find_packages, setup
 
+# Read the contents of README file
+from pathlib import Path
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
 setup(
     name='langdiversity',
     packages=find_packages(exclude=['tests']),
-    version='0.0.1',
+    version='0.0.2',
     description='A tool to elevate your language models with insightful diversity metrics.',
-    author='Noel Ngu, Nathaniel Lee',                         # change later
-    author_email='nngu2@asu.edu, nlee51@asu.edu',             # change later
-    url='https://github.com/your_github_username/langdiversity',  # change later
+    long_description=long_description,  
+    long_description_content_type="text/markdown",  
+    author='Noel Ngu, Nathaniel Lee',                        
+    author_email='nngu2@asu.edu, nlee51@asu.edu',             
+    url='https://github.com/lab-v2/diversity_package',  
     license='BSD 3-clause',
     install_requires=[
         'aiohttp==3.8.5',
@@ -44,10 +51,10 @@
         'Development Status :: 3 - Alpha',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: BSD License',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+
     ],
-    python_requires='>=3.7',
+    python_requires='>=3.9',
 )