https://github.com/chigwell/tech-discriptor
A new package designed to transform technical descriptions of hardware or software solutions into structured summaries and feature lists. It takes detailed textual inputs about various systems like Ro
https://github.com/chigwell/tech-discriptor
baremetal-analysis comparison-tool-support consistent-output design-goal-identification development-workflow-automation documentation-integration feature-extraction hardware-compatibility-detection multiprocessor-support pattern-matching portability-analysis reliable-output retry-mechanisms size-measurement structured-summarization technical-description-parsing textonly-processing
Last synced: 5 months ago
JSON representation
A new package designed to transform technical descriptions of hardware or software solutions into structured summaries and feature lists. It takes detailed textual inputs about various systems like Ro
- Host: GitHub
- URL: https://github.com/chigwell/tech-discriptor
- Owner: chigwell
- Created: 2025-12-21T16:19:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-12-21T16:19:18.000Z (5 months ago)
- Last Synced: 2025-12-23T06:10:56.626Z (5 months ago)
- Topics: baremetal-analysis, comparison-tool-support, consistent-output, design-goal-identification, development-workflow-automation, documentation-integration, feature-extraction, hardware-compatibility-detection, multiprocessor-support, pattern-matching, portability-analysis, reliable-output, retry-mechanisms, size-measurement, structured-summarization, technical-description-parsing, textonly-processing
- Language: Python
- Homepage: https://pypi.org/project/tech-discriptor/
- Size: 3.91 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tech-Discriptor
[](https://badge.fury.io/py/tech-discriptor)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/tech-discriptor)
[](https://www.linkedin.com/in/eugene-evstafev-716669181/)
Transform technical descriptions into structured summaries and feature lists
## Overview
A new package designed to transform technical descriptions of hardware or software solutions into structured summaries and feature lists.
## Installation
```bash
pip install tech_discriptor
```
## Example Usage
```python
from tech_discriptor import tech_discriptor
user_input = "Romforth—an ultra-portable, small, bare-metal Forth implementation for multiple processors—"
response = tech_discriptor(user_input)
print(response)
```
## 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 ChatLLM7 will be used.
## Supported LLMs
You can safely pass your own llm instance (based on ) if you want to use another LLM, via passing it like `tech_discriptor(user_input, llm=their_llm_instance)`.
### Examples
#### OpenAI
```python
from langchain_openai import ChatOpenAI
from tech_discriptor import tech_discriptor
llm = ChatOpenAI()
response = tech_discriptor(user_input, llm=llm)
```
#### Anthropic
```python
from langchain_anthropic import ChatAnthropic
from tech_discriptor import tech_discriptor
llm = ChatAnthropic()
response = tech_discriptor(user_input, llm=llm)
```
#### Google Generative AI
```python
from langchain_google_genai import ChatGoogleGenerativeAI
from tech_discriptor import tech_discriptor
llm = ChatGoogleGenerativeAI()
response = tech_discriptor(user_input, llm=llm)
```
## API Key for LLM7
The default `ChatLLM7` LLM is used if no custom LLM is provided. The free tier rate limits are generally sufficient. For higher rate limits with `ChatLLM7`, you can:
* Set the `LLM7_API_KEY` environment variable.
* Pass the API key directly: `tech_discriptor(user_input, api_key="your_api_key")`
You can obtain a free API key by registering at [https://token.llm7.io/](https://token.llm7.io/)
## Contributing
Contributions are welcome! Please refer to the GitHub repository for details.
## License
This project is licensed under the [MIT License](LICENSE).
## Author
* Eugene Evstafev (hi@eugene.plus)
## Contact
For issues or questions, please visit the GitHub issues page: [https://github.com/chigwell/tech-discriptor/](https://github.com/chigwell/tech-discriptor/)