A flexible Python library for generating and refining creative ideas using LLMs and embeddings.
Project description
Idealist
Idealist is a flexible Python library that leverages Large Language Models (LLMs) and embeddings to generate and refine creative ideas while avoiding repetition. It's ideal for generating unique names, themes, or any other creative content.
Features
- Dynamic Idea Generation: Customize parameters to generate a wide range of ideas.
- Model Flexibility: Use different LLMs and embedding models supported by LiteLLM.
- Uniqueness Assurance: Ensures all generated ideas are unique and not duplicated.
- Embedding Support: Uses embeddings to find and avoid similar ideas.
- Easy to Use: Simple interface with minimal setup.
Installation
You can install the library via pip:
pip install infinite-idealist
Usage
Create a New Generator
Here's a basic example of how to use the IdeaGenerator class to create a new generator:
from idea_generator import IdeaGenerator
import os
def main():
# Set up environment variables for API keys (optional, depending on the model used)
os.environ["OPENAI_API_KEY"] = "your_openai_api_key"
# os.environ["ANTHROPIC_API_KEY"] = "your_anthropic_api_key" # Optional if using Anthropic
# Initialize the IdeaGenerator
generator = IdeaGenerator(
name="Pokemon Names",
description="Generate unique and creative names for Pokemon characters",
model="gpt-4o-mini", # Specify the LLM model
embedding_model="text-embedding-ada-002", # Specify the embedding model
openai_api_key=os.getenv("OPENAI_API_KEY"), # Optional if using OpenAI
anthropic_api_key=os.getenv("ANTHROPIC_API_KEY"), # Optional if using Anthropic
max_recent_ideas=15, # Number of recent ideas to include in prompts
debug=False # Set to True for detailed logs
)
# Setup parameters
parameters = {
"name": "Name of Pokemon"
}
generator.setup_parameters(parameters)
# Generate ideas
for i in range(5):
idea = generator.generate_idea()
if idea:
print(f"Idea #{i+1}: {idea.get('name')}")
else:
print(f"Failed to generate Idea #{i+1}")
if __name__ == "__main__":
main()
Load an Existing Generator
You can also load an existing generator by its ID:
from idea_generator import IdeaGenerator
import os
def main():
# Set up environment variables for API keys (optional, depending on the model used)
os.environ["OPENAI_API_KEY"] = "your_openai_api_key"
# os.environ["ANTHROPIC_API_KEY"] = "your_anthropic_api_key" # Optional if using Anthropic
# Load an existing IdeaGenerator by ID
generator_id = "pokemon_names_20241212_050458" # Replace with your generator ID
generator = IdeaGenerator.load(
generator_id=generator_id,
model="gpt-4o-mini", # Specify the LLM model used during creation
embedding_model="text-embedding-ada-002", # Specify the embedding model used during creation
openai_api_key=os.getenv("OPENAI_API_KEY"), # Optional if using OpenAI
anthropic_api_key=os.getenv("ANTHROPIC_API_KEY"), # Optional if using Anthropic
max_recent_ideas=15, # Number of recent ideas to include in prompts
debug=False # Set to True for detailed logs
)
# Generate ideas
for i in range(5):
idea = generator.generate_idea()
if idea:
print(f"Idea #{i+1}: {idea.get('name')}")
else:
print(f"Failed to generate Idea #{i+1}")
if __name__ == "__main__":
main()
API Reference
IdeaGenerator Class
__init__
IdeaGenerator(
name: str,
description: str,
model: str = "gpt-4o-mini",
embedding_model: str = "text-embedding-ada-002",
anthropic_api_key: Optional[str] = None,
openai_api_key: Optional[str] = None,
max_recent_ideas: int = 20,
debug: bool = False,
generator_id: Optional[str] = None
)
- name: Name of the generator.
- description: Description of what this generator creates.
- model: The LLM model to use (e.g., 'gpt-4o-mini').
- embedding_model: The embedding model to use (e.g., 'text-embedding-ada-002').
- anthropic_api_key: API key for Anthropic (optional).
- openai_api_key: API key for OpenAI (optional).
- max_recent_ideas: Maximum number of recent ideas to include in prompts.
- debug: Enables detailed logging if set to
True. - generator_id: Optional ID to load an existing generator.
load Class Method
@classmethod
load(
generator_id: str,
model: str = "gpt-4o-mini",
embedding_model: str = "text-embedding-ada-002",
anthropic_api_key: Optional[str] = None,
openai_api_key: Optional[str] = None,
max_recent_ideas: int = 20,
debug: bool = False
) -> 'IdeaGenerator'
- generator_id: ID of the generator to load.
- model: The LLM model to use (must match the one used during creation).
- embedding_model: The embedding model to use (must match the one used during creation).
- anthropic_api_key: API key for Anthropic (optional).
- openai_api_key: API key for OpenAI (optional).
- max_recent_ideas: Maximum number of recent ideas to include in prompts.
- debug: Enables detailed logging if set to
True.
setup_parameters
setup_parameters(parameters: Dict[str, Any])
- parameters: Dictionary defining the structure of generated ideas.
generate_idea
generate_idea() -> Dict
- Generates a new idea based on the configured parameters.
- Returns a dictionary containing the generated idea.
Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
The GitHub repository for this project can be found at: https://github.com/yoheinakajima/idealist
License
This project is licensed under the MIT License. See the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file infinite_idealist-0.1.2.tar.gz.
File metadata
- Download URL: infinite_idealist-0.1.2.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
619a18b878c661caf23aba0ac8ea96e8c7bc27670b0dac9f6263fc9fba30dbd4
|
|
| MD5 |
f72a9e329dda0b9c49bb7ae8d863b541
|
|
| BLAKE2b-256 |
523bb7359484fc85a1116b769bd321b477ff32fce6d0e8c1aa6faec99be8e6e8
|
File details
Details for the file infinite_idealist-0.1.2-py3-none-any.whl.
File metadata
- Download URL: infinite_idealist-0.1.2-py3-none-any.whl
- Upload date:
- Size: 9.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d92d432cac3704c7e101bef684b81abb6b27e3d7af54cbc80eeae6f2289288f8
|
|
| MD5 |
e77357479b275410523217d10b8a200d
|
|
| BLAKE2b-256 |
ca0464e4994aaaba70b4e1f12532eaa965dd866905028536b405a5c1be6de73f
|