Skip to main content

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.
  • 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 idealist

Usage

Here's a basic example of how to use the IdeaGenerator class:

from idea_generator import IdeaGenerator
import os

def main():
    # Set up environment variables for API keys
    os.environ["ANTHROPIC_API_KEY"] = "your_anthropic_api_key"
    os.environ["OPENAI_API_KEY"] = "your_openai_api_key"

    # Initialize the IdeaGenerator
    generator = IdeaGenerator(
        name="Pokemon Names",
        description="Generate unique and creative names for Pokemon characters",
        anthropic_api_key=os.getenv("ANTHROPIC_API_KEY"),
        openai_api_key=os.getenv("OPENAI_API_KEY"),
        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()

API Reference

IdeaGenerator Class

__init__

IdeaGenerator(
    name: str,
    description: str,
    anthropic_api_key: str,
    openai_api_key: str,
    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.
  • anthropic_api_key: API key for Anthropic.
  • openai_api_key: API key for OpenAI.
  • 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.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

infinite_idealist-0.1.0.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

infinite_idealist-0.1.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file infinite_idealist-0.1.0.tar.gz.

File metadata

  • Download URL: infinite_idealist-0.1.0.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.9

File hashes

Hashes for infinite_idealist-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d15738117c829a41dbbe82cd245a87a495c4cc9065ee880a9db0e1c89e446a41
MD5 d7e0d1420d7eb240f94f5cbd2f541129
BLAKE2b-256 a8a44528e89172e2ccbb376193c65a32536f59b89f2748b129f6dc277c247b00

See more details on using hashes here.

File details

Details for the file infinite_idealist-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for infinite_idealist-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac2b3678ae100590f04a2565d28cfe39c88521ad26ba0af26e737a20ff34d4af
MD5 4b66c6c1faa378316a0cb28f16bbe77a
BLAKE2b-256 6050a1031836d74af77f5ae84e89ea0510ef7acbd6826eac953c68c18c216c93

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page