[](https://badge.fury.io/py/etoile_pixtral_description)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/etoile_pixtral_description)
# etoile_pixtral_description
`etoile_pixtral_description` is a Python package designed to extract detailed descriptions from images using advanced language models. It focuses on providing concrete descriptions of visible content characteristics on web pages or other digital media, making it particularly useful for content analysis, accessibility improvements, and SEO enhancements.
## Installation
To install `etoile_pixtral_description`, use pip:
```bash
pip install etoile_pixtral_description
```
## Usage
The package provides a function `describe_image` that generates a detailed description of the content found within an image. It uses the `ScreenContentSimplified` model for structured output.
### Setting Up the Model
```python
from langchain_mistralai import ChatMistralAI
CVISION_MODEL = "pixtral-12b-2409"
llm = ChatMistralAI(
model=CVISION_MODEL,
temperature=0,
max_retries=2,
)
```
### Describing an Image
```python
from etoile_pixtral_description import describe_image
# `screenshot.link` should be a string containing the URL to the image you want to describe.
screenshot_link = "https://example.com/path/to/screenshot.jpg"
result = describe_image(llm, screenshot_link, verbose=True)
print(result)
# Assuming `result` contains a property `description` which holds the detailed description.
```
This function returns a structured response with a detailed description of each content characteristic on the screen, which is useful for various applications, including digital asset management and accessibility compliance.
## Features
- Provides detailed and concrete descriptions of images for enhanced understanding and analysis.
- Utilizes advanced machine learning models to interpret and describe visual content.
- Supports detailed descriptions including the semantics of textual content and the aesthetics of visual elements.
## Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/Mistral-Etoile-London-Hackathon/issues).
## License
`etoile_pixtral_description` is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).
## Acknowledgements
This package was developed by [Evgenii (Eugene) Evstafev](https://www.linkedin.com/in/eugene-evstafev-716669181/) as part of the Mistral Étoile suite during the London Hackathon. It aims to provide tools that assist in the detailed analysis of digital content for various professional fields.
Raw data
{
"_id": null,
"home_page": null,
"name": "etoile-pixtral-description",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Eugene Evstafev",
"author_email": "chigwel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/dd/6f/bec859aad2c21a44eeea1b6d79da697919db9fed44e48d1891f523525129/etoile_pixtral_description-0.0.1.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/etoile_pixtral_description)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/etoile_pixtral_description)\n\n# etoile_pixtral_description\n\n`etoile_pixtral_description` is a Python package designed to extract detailed descriptions from images using advanced language models. It focuses on providing concrete descriptions of visible content characteristics on web pages or other digital media, making it particularly useful for content analysis, accessibility improvements, and SEO enhancements.\n\n## Installation\n\nTo install `etoile_pixtral_description`, use pip:\n\n```bash\npip install etoile_pixtral_description\n```\n\n## Usage\n\nThe package provides a function `describe_image` that generates a detailed description of the content found within an image. It uses the `ScreenContentSimplified` model for structured output.\n\n### Setting Up the Model\n\n```python\nfrom langchain_mistralai import ChatMistralAI\n\nCVISION_MODEL = \"pixtral-12b-2409\"\n\nllm = ChatMistralAI(\n model=CVISION_MODEL,\n temperature=0,\n max_retries=2,\n)\n```\n\n### Describing an Image\n\n```python\nfrom etoile_pixtral_description import describe_image\n\n# `screenshot.link` should be a string containing the URL to the image you want to describe.\nscreenshot_link = \"https://example.com/path/to/screenshot.jpg\"\nresult = describe_image(llm, screenshot_link, verbose=True)\nprint(result)\n# Assuming `result` contains a property `description` which holds the detailed description.\n```\n\nThis function returns a structured response with a detailed description of each content characteristic on the screen, which is useful for various applications, including digital asset management and accessibility compliance.\n\n## Features\n\n- Provides detailed and concrete descriptions of images for enhanced understanding and analysis.\n- Utilizes advanced machine learning models to interpret and describe visual content.\n- Supports detailed descriptions including the semantics of textual content and the aesthetics of visual elements.\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/Mistral-Etoile-London-Hackathon/issues).\n\n## License\n\n`etoile_pixtral_description` is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).\n\n## Acknowledgements\n\nThis package was developed by [Evgenii (Eugene) Evstafev](https://www.linkedin.com/in/eugene-evstafev-716669181/) as part of the Mistral \u00c9toile suite during the London Hackathon. It aims to provide tools that assist in the detailed analysis of digital content for various professional fields.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "0.0.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d7ac60a24cb90ad36f514de39f3c989cd3293d6fc545401d8982a30c658a32a",
"md5": "bff9d753073abfad62d9d31312922b60",
"sha256": "03bc05123bf788c127cd754dfc1cf5c083dd66f17e9bb2541ca311a1cf731308"
},
"downloads": -1,
"filename": "etoile_pixtral_description-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bff9d753073abfad62d9d31312922b60",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4163,
"upload_time": "2024-10-06T04:09:47",
"upload_time_iso_8601": "2024-10-06T04:09:47.996492Z",
"url": "https://files.pythonhosted.org/packages/1d/7a/c60a24cb90ad36f514de39f3c989cd3293d6fc545401d8982a30c658a32a/etoile_pixtral_description-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd6fbec859aad2c21a44eeea1b6d79da697919db9fed44e48d1891f523525129",
"md5": "8fc01e780a47f3a83c9b667e77b8c427",
"sha256": "e190f20c4ec504cf2eb372dd2c89366d38f1b403e86a8dcbbca8c45a56da2f1c"
},
"downloads": -1,
"filename": "etoile_pixtral_description-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8fc01e780a47f3a83c9b667e77b8c427",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3546,
"upload_time": "2024-10-06T04:09:49",
"upload_time_iso_8601": "2024-10-06T04:09:49.894895Z",
"url": "https://files.pythonhosted.org/packages/dd/6f/bec859aad2c21a44eeea1b6d79da697919db9fed44e48d1891f523525129/etoile_pixtral_description-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-06 04:09:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "etoile-pixtral-description"
}
JSON