| Name | autodistill-albef JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | ALBEF module for use with Autodistill |
| upload_time | 2023-06-30 09:15:02 |
| maintainer | |
| docs_url | None |
| author | Roboflow |
| requires_python | >=3.7 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<p>
<a align="center" href="" target="_blank">
<img
width="850"
src="https://media.roboflow.com/open-source/autodistill/autodistill-banner.png?4"
>
</a>
</p>
</div>
# Autodistill ALBEF Module
This repository contains the code supporting the ALBEF base model for use with [Autodistill](https://github.com/autodistill/autodistill).
[ALBEF](https://github.com/salesforce/LAVIS), developed by Salesforce, is a computer vision model that supports a range of tasks, including image-text pre-training, image-text retrieval, visual question anserting, and zero-shot classification. You can classify images using ALBEF with Autodistill.
Read the full [Autodistill documentation](https://autodistill.github.io/autodistill/).
Read the [ALBEF Autodistill documentation](https://autodistill.github.io/autodistill/base_models/albef/).
## Installation
To use ALBEF with autodistill, you need to install the following dependency:
```bash
pip3 install autodistill-albef
```
## Quickstart
```python
from autodistill_albef import ALBEF
# define an ontology to map class names to our ALBEF prompt
# the ontology dictionary has the format {caption: class}
# where caption is the prompt sent to the base model, and class is the label that will
# be saved for that caption in the generated annotations
# then, load the model
base_model = ALBEF(
ontology=CaptionOntology(
{
"person": "person",
"a forklift": "forklift"
}
)
)
base_model.label("./context_images", extension=".jpeg")
```
## License
This project is licensed under a [3-Clause BSD license](LICENSE).
## 🏆 Contributing
We love your input! Please see the core Autodistill [contributing guide](https://github.com/autodistill/autodistill/blob/main/CONTRIBUTING.md) to get started. Thank you 🙏 to all our contributors!
Raw data
{
"_id": null,
"home_page": "",
"name": "autodistill-albef",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Roboflow",
"author_email": "support@roboflow.com",
"download_url": "https://files.pythonhosted.org/packages/a6/84/0f8993feec91b3a121a067ee9ac8c0e9fa76f749a10f79a8fd33719d004c/autodistill-albef-0.1.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <p>\n <a align=\"center\" href=\"\" target=\"_blank\">\n <img\n width=\"850\"\n src=\"https://media.roboflow.com/open-source/autodistill/autodistill-banner.png?4\"\n >\n </a>\n </p>\n</div>\n\n# Autodistill ALBEF Module\n\nThis repository contains the code supporting the ALBEF base model for use with [Autodistill](https://github.com/autodistill/autodistill).\n\n[ALBEF](https://github.com/salesforce/LAVIS), developed by Salesforce, is a computer vision model that supports a range of tasks, including image-text pre-training, image-text retrieval, visual question anserting, and zero-shot classification. You can classify images using ALBEF with Autodistill.\n\nRead the full [Autodistill documentation](https://autodistill.github.io/autodistill/).\n\nRead the [ALBEF Autodistill documentation](https://autodistill.github.io/autodistill/base_models/albef/).\n\n## Installation\n\nTo use ALBEF with autodistill, you need to install the following dependency:\n\n\n```bash\npip3 install autodistill-albef\n```\n\n## Quickstart\n\n```python\nfrom autodistill_albef import ALBEF\n\n# define an ontology to map class names to our ALBEF prompt\n# the ontology dictionary has the format {caption: class}\n# where caption is the prompt sent to the base model, and class is the label that will\n# be saved for that caption in the generated annotations\n# then, load the model\nbase_model = ALBEF(\n ontology=CaptionOntology(\n {\n \"person\": \"person\",\n \"a forklift\": \"forklift\"\n }\n )\n)\nbase_model.label(\"./context_images\", extension=\".jpeg\")\n```\n\n\n## License\n\nThis project is licensed under a [3-Clause BSD license](LICENSE).\n\n## \ud83c\udfc6 Contributing\n\nWe love your input! Please see the core Autodistill [contributing guide](https://github.com/autodistill/autodistill/blob/main/CONTRIBUTING.md) to get started. Thank you \ud83d\ude4f to all our contributors!\n",
"bugtrack_url": null,
"license": "",
"summary": "ALBEF module for use with Autodistill",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e72752e75300fbc51b727230bfb5804d4c5b24e79401522b99c8fb2602b48c98",
"md5": "24cc3acb8ddf85b4d3458b644edafb31",
"sha256": "60939821499c4619a24656f773daedbd2febf98f004f2f5e7abe3f0b7bd4a915"
},
"downloads": -1,
"filename": "autodistill_albef-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24cc3acb8ddf85b4d3458b644edafb31",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4622,
"upload_time": "2023-06-30T09:15:00",
"upload_time_iso_8601": "2023-06-30T09:15:00.757952Z",
"url": "https://files.pythonhosted.org/packages/e7/27/52e75300fbc51b727230bfb5804d4c5b24e79401522b99c8fb2602b48c98/autodistill_albef-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a6840f8993feec91b3a121a067ee9ac8c0e9fa76f749a10f79a8fd33719d004c",
"md5": "c62db3a8b510e18520e40f41e5e036b7",
"sha256": "acc56bc7c75348a378124114516aeb9ff03beb046cce2fe6ffa37b3ca1119a72"
},
"downloads": -1,
"filename": "autodistill-albef-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c62db3a8b510e18520e40f41e5e036b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4236,
"upload_time": "2023-06-30T09:15:02",
"upload_time_iso_8601": "2023-06-30T09:15:02.762428Z",
"url": "https://files.pythonhosted.org/packages/a6/84/0f8993feec91b3a121a067ee9ac8c0e9fa76f749a10f79a8fd33719d004c/autodistill-albef-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-30 09:15:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "autodistill-albef"
}
