Skip to content

A new package that leverages pattern-matched interactions with language models to generate structured summaries of software updates from user-provided text snippets. It focuses on extracting key featu

Notifications You must be signed in to change notification settings

chigwell/summify-release

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

summify_release

PyPI version License: MIT Downloads LinkedIn

Overview

A new package that leverages pattern-matched interactions with language models to generate structured summaries of software updates from user-provided text snippets. It focuses on extracting key features, release highlights, and version improvements to deliver concise, organized reports for end-users or documentation purposes, without processing media or external URLs.

Installation

pip install summify_release

Usage

from summify_release import summify_release

Input Parameters

  • user_input: str: the user input text to process
  • llm: Optional[BaseChatModel]: the langchain llm instance to use, if not provided the default ChatLLM7 will be used.
  • api_key: Optional[str]: the api key for llm7, if not provided the default LLM7 api key from the environment variable LLM7_API_KEY will be used.

You can safely pass your own llm instance (based on https://docs.langchain.com/) if you want to use another LLM, via passing it like summify_release(user_input, llm=your_llm_instance), for example to use the openai https://docs.openai.com/:

from langchain_openai import ChatOpenAI
from summify_release import summify_release
llm = ChatOpenAI()
response = summify_release(user_input, llm=llm)

or for example to use the anthropic https://docs.anthropic.tech/:

from langchain_anthropic import ChatAnthropic
from summify_release import summify_release
llm = ChatAnthropic()
response = summify_release(user_input, llm=llm)

or google https://docs.google.com/ai-book/docs/:

from langchain_google_genai import ChatGoogleGenerativeAI
from summify_release import summify_release
llm = ChatGoogleGenerativeAI()
response = summify_release(user_input, llm=llm)

LLM7 API Key

The default rate limits for LLM7 free tier are sufficient for most use cases of this package. If you want higher rate limits for LLM7 you can pass your own api_key via environment variable LLM7_API_KEY or via passing it directly like summify_release(user_input, api_key="your_api_key").

You can obtain a free api key by registering at https://token.llm7.io/

Contributing

Contributions are welcome! Please refer to the issue tracker for details.

License

This project is licensed under the MIT License.

Author

GitHub Issues

https://github.com/chigwell/summify-release/issues

Releases

No releases published

Packages

No packages published

Languages