diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index acc29c7..12382ef 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,15 +28,11 @@ jobs: - name: Install main run: | - pip install -e git+https://github.com/osamproject/osam-core.git#egg=osam-core - pip install -e git+https://github.com/osamproject/osam-efficientsam.git#egg=osam-efficientsam - pip install -e git+https://github.com/osamproject/osam-sam.git#egg=osam-sam - pip install -e git+https://github.com/osamproject/osam-yoloworld.git#egg=osam-yoloworld pip install .[test] - name: Lint run: | - make lint + make lint mypy - name: Test run: | diff --git a/Makefile b/Makefile index d9887e3..842ec38 100644 --- a/Makefile +++ b/Makefile @@ -5,10 +5,12 @@ all: PACKAGE_DIR=osam +mypy: + mypy --package $(PACKAGE_DIR) + lint: ruff format --check ruff check - mypy --package $(PACKAGE_DIR) format: ruff format diff --git a/osam/__init__.py b/osam/__init__.py index 6dab54f..68884bc 100644 --- a/osam/__init__.py +++ b/osam/__init__.py @@ -2,6 +2,5 @@ __version__ = importlib.metadata.version("osam") -from . import _models # noqa: F401 from . import apis # noqa: F401 from . import types # noqa: F401 diff --git a/osam/__main__.py b/osam/__main__.py index 751e399..d0d3694 100644 --- a/osam/__main__.py +++ b/osam/__main__.py @@ -10,12 +10,12 @@ import PIL.Image import uvicorn from loguru import logger -from osam_core import apis -from osam_core import types from . import __version__ from . import _humanize from . import _tabulate +from . import apis +from . import types @click.group(context_settings=dict(help_option_names=["-h", "--help"])) @@ -131,7 +131,9 @@ def run(model_name: str, image_path: str, prompt, json: bool) -> None: if request.prompt and request.prompt.texts is not None: labels = [ - 1 + request.prompt.texts.index(annotation.text) + 0 + if annotation.text is None + else 1 + request.prompt.texts.index(annotation.text) for annotation in response.annotations ] else: diff --git a/osam/_contextlib.py b/osam/_contextlib.py new file mode 100644 index 0000000..fed40ec --- /dev/null +++ b/osam/_contextlib.py @@ -0,0 +1,28 @@ +import contextlib +import os +import sys +import tempfile + + +@contextlib.contextmanager +def suppress(): + original_stdout_fd = os.dup(sys.stdout.fileno()) + original_stderr_fd = os.dup(sys.stderr.fileno()) + + with tempfile.TemporaryFile(mode="w+b") as temp_stdout, tempfile.TemporaryFile( + mode="w+b" + ) as temp_stderr: + os.dup2(temp_stdout.fileno(), sys.stdout.fileno()) + os.dup2(temp_stderr.fileno(), sys.stderr.fileno()) + + try: + yield + finally: + sys.stdout.flush() + sys.stderr.flush() + + os.dup2(original_stdout_fd, sys.stdout.fileno()) + os.dup2(original_stderr_fd, sys.stderr.fileno()) + + os.close(original_stdout_fd) + os.close(original_stderr_fd) diff --git a/osam/_json.py b/osam/_json.py new file mode 100644 index 0000000..61a9731 --- /dev/null +++ b/osam/_json.py @@ -0,0 +1,19 @@ +import base64 +import io + +import numpy as np +import PIL.Image + + +def image_ndarray_to_b64data(ndarray): + pil = PIL.Image.fromarray(ndarray) + f = io.BytesIO() + pil.save(f, format="PNG") + data = f.getvalue() + return base64.b64encode(data).decode("utf-8") + + +def image_b64data_to_ndarray(b64data): + data = base64.b64decode(b64data) + pil = PIL.Image.open(io.BytesIO(data)) + return np.asarray(pil) diff --git a/osam/_json_test.py b/osam/_json_test.py new file mode 100644 index 0000000..4c4d716 --- /dev/null +++ b/osam/_json_test.py @@ -0,0 +1,25 @@ +import numpy as np +import pytest + +from . import _json + + +@pytest.fixture +def image(): + y, x = np.meshgrid(np.arange(10), np.arange(10)) + center = (np.array(x.shape) - 1) / 2 + image_float = np.exp(-((x - center[1]) ** 2 + (y - center[0]) ** 2) / 10) + image = (image_float * 255).astype(np.uint8) + return image + + +def test_image_ndarray_to_b64data(image): + b64data = _json.image_ndarray_to_b64data(image) + assert isinstance(b64data, str) + assert len(b64data) == 204 + + +def test_image_b64data_to_ndarray(image): + b64data = _json.image_ndarray_to_b64data(image) + image_recovered = _json.image_b64data_to_ndarray(b64data) + np.testing.assert_array_equal(image, image_recovered) diff --git a/osam/_models.py b/osam/_models.py deleted file mode 100644 index 17f824b..0000000 --- a/osam/_models.py +++ /dev/null @@ -1,4 +0,0 @@ -# import modules to register the models -import osam_efficientsam # noqa: F401 -import osam_sam # noqa: F401 -import osam_yoloworld # noqa: F401 diff --git a/osam/_models/__init__.py b/osam/_models/__init__.py new file mode 100644 index 0000000..7f4dbe8 --- /dev/null +++ b/osam/_models/__init__.py @@ -0,0 +1,6 @@ +from .efficientsam import EfficientSam10m # noqa: F401 +from .efficientsam import EfficientSam30m # noqa: F401 +from .sam import Sam100m # noqa: F401 +from .sam import Sam300m # noqa: F401 +from .sam import Sam600m # noqa: F401 +from .yoloworld import YoloWorldXL # noqa: F401 diff --git a/osam/_models/efficientsam/LICENSE b/osam/_models/efficientsam/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/osam/_models/efficientsam/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/osam/_models/efficientsam/__init__.py b/osam/_models/efficientsam/__init__.py new file mode 100644 index 0000000..07f31c5 --- /dev/null +++ b/osam/_models/efficientsam/__init__.py @@ -0,0 +1,126 @@ +import imgviz +import numpy as np +from loguru import logger + +from ... import types + + +class EfficientSam(types.Model): + def encode_image(self, image: np.ndarray) -> types.ImageEmbedding: + if image.ndim == 2: + raise ValueError("Grayscale images are not supported") + if image.ndim == 3 and image.shape[2] == 4: + raise ValueError("RGBA images are not supported") + + batched_images = image.transpose(2, 0, 1)[None].astype(np.float32) / 255 + image_embedding = self._inference_sessions["encoder"].run( + output_names=None, + input_feed={"batched_images": batched_images}, + )[0][0] # (embedding_dim, height, width) + + return types.ImageEmbedding( + original_height=image.shape[0], + original_width=image.shape[1], + embedding=image_embedding, + ) + + def generate(self, request: types.GenerateRequest) -> types.GenerateResponse: + if request.image_embedding is None: + if request.image is None: + raise ValueError("request.image or request.image_embedding is required") + image_embedding = self.encode_image(request.image) + else: + image_embedding = request.image_embedding + + if request.prompt is None: + prompt = types.Prompt( + points=np.array( + [ + [ + image_embedding.original_width / 2, + image_embedding.original_height / 2, + ] + ], + dtype=np.float32, + ), + point_labels=np.array([1], dtype=np.int32), + ) + logger.warning( + "Prompt is not given, so using the center point as prompt: {prompt!r}", + prompt=prompt, + ) + else: + prompt = request.prompt + del request + + if prompt.points is None or prompt.point_labels is None: + raise ValueError("Prompt must contain points and point_labels: %r", prompt) + + input_point = np.array(prompt.points, dtype=np.float32) + input_label = np.array(prompt.point_labels, dtype=np.float32) + + # batch_size, embedding_dim, height, width + batched_image_embedding = image_embedding.embedding[None, :, :, :] + # batch_size, num_queries, num_points, 2 + batched_point_coords = input_point[None, None, :, :] + # batch_size, num_queries, num_points + batched_point_labels = input_label[None, None, :] + + decoder_inputs = { + "image_embeddings": batched_image_embedding, + "batched_point_coords": batched_point_coords, + "batched_point_labels": batched_point_labels, + "orig_im_size": np.array( + (image_embedding.original_height, image_embedding.original_width), + dtype=np.int64, + ), + } + + masks, _, _ = self._inference_sessions["decoder"].run(None, decoder_inputs) + mask = masks[0, 0, 0, :, :] # (1, 1, 3, H, W) -> (H, W) + mask = mask > 0.0 + + bbox = imgviz.instances.mask_to_bbox([mask])[0].astype(int) + + return types.GenerateResponse( + model=self.name, + image_embedding=image_embedding, + annotations=[ + types.Annotation( + mask=mask, + bounding_box=types.BoundingBox( + ymin=bbox[0], xmin=bbox[1], ymax=bbox[2], xmax=bbox[3] + ), + ) + ], + ) + + +class EfficientSam10m(EfficientSam): + name = "efficientsam:10m" + + _blobs = { + "encoder": types.Blob( + url="https://github.com/labelmeai/efficient-sam/releases/download/onnx-models-20231225/efficient_sam_vitt_encoder.onnx", + hash="sha256:7a73ee65aa2c37237c89b4b18e73082f757ffb173899609c5d97a2bbd4ebb02d", + ), + "decoder": types.Blob( + url="https://github.com/labelmeai/efficient-sam/releases/download/onnx-models-20231225/efficient_sam_vitt_decoder.onnx", + hash="sha256:e1afe46232c3bfa3470a6a81c7d3181836a94ea89528aff4e0f2d2c611989efd", + ), + } + + +class EfficientSam30m(EfficientSam): + name = "efficientsam:latest" + + _blobs = { + "encoder": types.Blob( + url="https://github.com/labelmeai/efficient-sam/releases/download/onnx-models-20231225/efficient_sam_vits_encoder.onnx", + hash="sha256:4cacbb23c6903b1acf87f1d77ed806b840800c5fcd4ac8f650cbffed474b8896", + ), + "decoder": types.Blob( + url="https://github.com/labelmeai/efficient-sam/releases/download/onnx-models-20231225/efficient_sam_vits_decoder.onnx", + hash="sha256:4727baf23dacfb51d4c16795b2ac382c403505556d0284e84c6ff3d4e8e36f22", + ), + } diff --git a/osam/_models/sam/LICENSE b/osam/_models/sam/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/osam/_models/sam/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/osam/_models/sam/__init__.py b/osam/_models/sam/__init__.py new file mode 100644 index 0000000..e45ab28 --- /dev/null +++ b/osam/_models/sam/__init__.py @@ -0,0 +1,216 @@ +import numpy as np +import PIL.Image +from loguru import logger + +from ... import types + + +class Sam(types.Model): + _image_size: int = 1024 + + def encode_image(self, image: np.ndarray) -> types.ImageEmbedding: + if image.ndim == 2: + raise ValueError("Grayscale images are not supported") + if image.ndim == 3 and image.shape[2] == 4: + raise ValueError("RGBA images are not supported") + + image_embedding = _compute_image_embedding( + encoder_session=self._inference_sessions["encoder"], + image=image, + image_size=self._image_size, + ) + + return types.ImageEmbedding( + original_height=image.shape[0], + original_width=image.shape[1], + embedding=image_embedding, + ) + + def generate(self: "Sam", request: types.GenerateRequest) -> types.GenerateResponse: + if request.image_embedding is None: + if request.image is None: + raise ValueError("request.image or request.image_embedding is required") + image_embedding = self.encode_image(request.image) + else: + image_embedding = request.image_embedding + + if request.prompt is None: + prompt = types.Prompt( + points=np.array( + [ + [ + image_embedding.original_width / 2, + image_embedding.original_height / 2, + ] + ], + dtype=np.float32, + ), + point_labels=np.array([1], dtype=np.int32), + ) + logger.warning( + "Prompt is not given, so using the center point as prompt: {prompt!r}", + prompt=prompt, + ) + else: + prompt = request.prompt + del request + + if prompt.points is None or prompt.point_labels is None: + raise ValueError("Prompt must contain points and point_labels: %r", prompt) + + mask = _generate_mask( + decoder_session=self._inference_sessions["decoder"], + image_embedding=image_embedding, + prompt=prompt, + image_size=self._image_size, + ) + return types.GenerateResponse( + model=self.name, + image_embedding=image_embedding, + annotations=[types.Annotation(mask=mask)], + ) + + +def _compute_scale_to_resize_image(height: int, width: int, image_size: int): + if width > height: + scale = image_size / width + new_height = int(round(height * scale)) + new_width = image_size + else: + scale = image_size / height + new_height = image_size + new_width = int(round(width * scale)) + return scale, new_height, new_width + + +def _resize_image(image: np.ndarray, image_size: int): + scale, new_height, new_width = _compute_scale_to_resize_image( + height=image.shape[0], + width=image.shape[1], + image_size=image_size, + ) + scaled_image = np.asarray( + PIL.Image.fromarray(image).resize( + (new_width, new_height), resample=PIL.Image.BILINEAR + ) + ).astype(np.float32) + return scale, scaled_image + + +def _compute_image_embedding( + encoder_session, + image: np.ndarray, + image_size: int, +): + scale, x = _resize_image(image=image, image_size=image_size) + x = (x - np.array([123.675, 116.28, 103.53], dtype=np.float32)) / np.array( + [58.395, 57.12, 57.375], dtype=np.float32 + ) + x = np.pad( + x, + ( + (0, image_size - x.shape[0]), + (0, image_size - x.shape[1]), + (0, 0), + ), + ) + x = x.transpose(2, 0, 1)[None, :, :, :] + + output = encoder_session.run(output_names=None, input_feed={"x": x}) + image_embedding = output[0][0] # (embedding_dim, height, width) + return image_embedding + + +def _generate_mask( + decoder_session, + image_embedding: types.ImageEmbedding, + prompt: types.Prompt, + image_size: int, +): + if prompt.points is None or prompt.point_labels is None: + raise ValueError("Prompt must contain points and point_labels: %r" % prompt) + + onnx_coord = np.concatenate([prompt.points, np.array([[0.0, 0.0]])], axis=0)[ + None, :, : + ] + onnx_label = np.concatenate([prompt.point_labels, np.array([-1])], axis=0)[ + None, : + ].astype(np.float32) + + scale, new_height, new_width = _compute_scale_to_resize_image( + height=image_embedding.original_height, + width=image_embedding.original_width, + image_size=image_size, + ) + onnx_coord = ( + onnx_coord.astype(float) + * ( + new_width / image_embedding.original_width, + new_height / image_embedding.original_height, + ) + ).astype(np.float32) + + onnx_mask_input = np.zeros((1, 1, 256, 256), dtype=np.float32) + onnx_has_mask_input = np.array([-1], dtype=np.float32) + + decoder_inputs = { + "image_embeddings": image_embedding.embedding[None, :, :, :], + "point_coords": onnx_coord, + "point_labels": onnx_label, + "mask_input": onnx_mask_input, + "has_mask_input": onnx_has_mask_input, + "orig_im_size": np.array( + (image_embedding.original_height, image_embedding.original_width), + dtype=np.float32, + ), + } + + masks, _, _ = decoder_session.run(None, decoder_inputs) + mask = masks[0, 0] # (1, 1, H, W) -> (H, W) + mask = mask > 0.0 + return mask + + +class Sam100m(Sam): + name = "sam:100m" + + _blobs = { + "encoder": types.Blob( + url="https://github.com/wkentaro/labelme/releases/download/sam-20230416/sam_vit_b_01ec64.quantized.encoder.onnx", + hash="sha256:3346b9cc551c9902fbf3b203935e933592b22e042365f58321c17fc12641fd6a", + ), + "decoder": types.Blob( + url="https://github.com/wkentaro/labelme/releases/download/sam-20230416/sam_vit_b_01ec64.quantized.decoder.onnx", + hash="sha256:edbcf1a0afaa55621fb0abe6b3db1516818b609ea9368f309746a3afc68f7613", + ), + } + + +class Sam300m(Sam): + name = "sam:300m" + + _blobs = { + "encoder": types.Blob( + url="https://github.com/wkentaro/labelme/releases/download/sam-20230416/sam_vit_l_0b3195.quantized.encoder.onnx", + hash="sha256:f7158a4a1fe7f670ef47ea2f7f852685425c1ed6caa40f5df86cbe2b0502034f", + ), + "decoder": types.Blob( + url="https://github.com/wkentaro/labelme/releases/download/sam-20230416/sam_vit_l_0b3195.quantized.decoder.onnx", + hash="sha256:552ebb23bf52c5e5b971ac710d1eb8dccfd88b36cc6aff881d1536d1662e6d7b", + ), + } + + +class Sam600m(Sam): + name = "sam:latest" + + _blobs = { + "encoder": types.Blob( + url="https://github.com/wkentaro/labelme/releases/download/sam-20230416/sam_vit_h_4b8939.quantized.encoder.onnx", + hash="sha256:a5c745fd4279efc5e5436b412200e983dafc2249ce172af6cc0002a71bb5f485", + ), + "decoder": types.Blob( + url="https://github.com/wkentaro/labelme/releases/download/sam-20230416/sam_vit_h_4b8939.quantized.decoder.onnx", + hash="sha256:020b385a45ffe51097e1acd10cd791075a86171153505f789a793bc382eef210", + ), + } diff --git a/osam/_models/yoloworld/LICENSE b/osam/_models/yoloworld/LICENSE new file mode 100644 index 0000000..dd8b209 --- /dev/null +++ b/osam/_models/yoloworld/LICENSE @@ -0,0 +1,1347 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/osam/_models/yoloworld/__init__.py b/osam/_models/yoloworld/__init__.py new file mode 100644 index 0000000..6957254 --- /dev/null +++ b/osam/_models/yoloworld/__init__.py @@ -0,0 +1,181 @@ +from typing import Tuple + +import imgviz +import numpy as np +import onnxruntime +from loguru import logger + +from ... import types +from . import clip + + +class _YoloWorld(types.Model): + _image_size: int + + def generate(self, request: types.GenerateRequest) -> types.GenerateResponse: + if request.prompt is None: + prompt = types.Prompt(texts=["anything"]) + logger.warning( + "Prompt is not given, so using 'anything' as prompt: {prompt!r}", + prompt=prompt, + ) + else: + prompt = request.prompt + + if prompt.texts is None: + raise ValueError("prompt.texts is required: prompt=%r", prompt) + token = clip.tokenize(texts=prompt.texts + [" "]) + (text_features,) = self._inference_sessions["textual"].run( + None, {"input": token} + ) + text_features = text_features / np.linalg.norm( + text_features, ord=2, axis=1, keepdims=True + ) + # + if request.image is None: + raise ValueError("request.image is required: request=%r", request) + transformed_image, original_image_hw, padding_hw = _transform_image( + image=request.image, image_size=self._image_size + ) + scores, bboxes = self._inference_sessions["yolo"].run( + output_names=["scores", "boxes"], + input_feed={ + "images": transformed_image[None], + "text_features": text_features[None], + }, + ) + scores = scores[0] + bboxes = bboxes[0] + # + iou_threshold = 1.0 if prompt.iou_threshold is None else prompt.iou_threshold + score_threshold = ( + 0.0 if prompt.score_threshold is None else prompt.score_threshold + ) + max_annotations = ( + len(bboxes) if prompt.max_annotations is None else prompt.max_annotations + ) + bboxes, scores, labels = _non_maximum_suppression( + inference_session=self._inference_sessions["nms"], + boxes=bboxes, + scores=scores, + iou_threshold=iou_threshold, + score_threshold=score_threshold, + max_num_detections=max_annotations, + ) + bboxes = _untransform_bboxes( + bboxes=bboxes, + image_size=self._image_size, + original_image_hw=original_image_hw, + padding_hw=padding_hw, + ) + annotations = [ + types.Annotation( + bounding_box=types.BoundingBox( + xmin=bbox[0], ymin=bbox[1], xmax=bbox[2], ymax=bbox[3] + ), + text=prompt.texts[label], + score=score, + ) + for bbox, label, score in zip(bboxes, labels, scores) + ] + return types.GenerateResponse( + model=self.name, + image_embedding=None, + annotations=annotations, + ) + + +class YoloWorldXL(_YoloWorld): + name: str = "yoloworld:latest" + + _image_size = 640 + _blobs = { + "textual": types.Blob( + url="https://clip-as-service.s3.us-east-2.amazonaws.com/models/onnx/ViT-B-32/textual.onnx", + hash="sha256:55c85d8cbb096023781c1d13c557eb95d26034c111bd001b7360fdb7399eec68", + ), + "yolo": types.Blob( + url="https://github.com/wkentaro/yolo-world-onnx/releases/download/v0.1.0/yolo_world_v2_xl_vlpan_bn_2e-3_100e_4x8gpus_obj365v1_goldg_train_lvis_minival.onnx", + hash="sha256:92660c6456766439a2670cf19a8a258ccd3588118622a15959f39e253731c05d", + ), + "nms": types.Blob( + url="https://github.com/wkentaro/yolo-world-onnx/releases/download/v0.1.0/non_maximum_suppression.onnx", + hash="sha256:328310ba8fdd386c7ca63fc9df3963cc47b1268909647abd469e8ebdf7f3d20a", + ), + } + + +def _transform_image( + image: np.ndarray, image_size: int +) -> Tuple[np.ndarray, Tuple[int, int], Tuple[int, int]]: + height, width = image.shape[:2] + + scale = image_size / max(height, width) + image_resized = imgviz.resize( + image, + height=int(height * scale), + width=int(width * scale), + interpolation="linear", + ) + pad_height = image_size - image_resized.shape[0] + pad_width = image_size - image_resized.shape[1] + image_resized = np.pad( + image_resized, + ( + (pad_height // 2, pad_height - pad_height // 2), + (pad_width // 2, pad_width - pad_width // 2), + (0, 0), + ), + mode="constant", + constant_values=114, + ) + input_image = image_resized.transpose(2, 0, 1).astype(np.float32) / 255.0 + return input_image, (height, width), (pad_height, pad_width) + + +def _untransform_bboxes( + bboxes: np.ndarray, + image_size: int, + original_image_hw: Tuple[int, int], + padding_hw: Tuple[int, int], +) -> np.ndarray: + bboxes -= np.array([padding_hw[1] // 2, padding_hw[0] // 2] * 2) + bboxes /= image_size / max(original_image_hw) + bboxes[:, 0::2] = np.clip(bboxes[:, 0::2], 0, original_image_hw[1]) + bboxes[:, 1::2] = np.clip(bboxes[:, 1::2], 0, original_image_hw[0]) + bboxes = bboxes.round().astype(int) + return bboxes + + +def _non_maximum_suppression( + inference_session: onnxruntime.InferenceSession, + boxes: np.ndarray, + scores: np.ndarray, + iou_threshold: float, + score_threshold: float, + max_num_detections: int, +) -> Tuple[np.ndarray, np.ndarray, np.ndarray]: + selected_indices = inference_session.run( + output_names=["selected_indices"], + input_feed={ + "boxes": boxes[None, :, :], + "scores": scores[None, :, :].transpose(0, 2, 1), + "max_output_boxes_per_class": np.array( + [max_num_detections], dtype=np.int64 + ), + "iou_threshold": np.array([iou_threshold], dtype=np.float32), + "score_threshold": np.array([score_threshold], dtype=np.float32), + }, + )[0] + labels = selected_indices[:, 1] + box_indices = selected_indices[:, 2] + boxes = boxes[box_indices] + scores = scores[box_indices, labels] + + if len(boxes) > max_num_detections: + keep_indices = np.argsort(scores)[-max_num_detections:] + boxes = boxes[keep_indices] + scores = scores[keep_indices] + labels = labels[keep_indices] + + return boxes, scores, labels diff --git a/osam/_models/yoloworld/clip/LICENSE b/osam/_models/yoloworld/clip/LICENSE new file mode 100644 index 0000000..c123b69 --- /dev/null +++ b/osam/_models/yoloworld/clip/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 OpenAI + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/osam/_models/yoloworld/clip/__init__.py b/osam/_models/yoloworld/clip/__init__.py new file mode 100644 index 0000000..def9fd2 --- /dev/null +++ b/osam/_models/yoloworld/clip/__init__.py @@ -0,0 +1 @@ +from .clip import tokenize # noqa: F401 diff --git a/osam/_models/yoloworld/clip/bpe_simple_vocab_16e6.txt.gz b/osam/_models/yoloworld/clip/bpe_simple_vocab_16e6.txt.gz new file mode 100644 index 0000000..7b5088a Binary files /dev/null and b/osam/_models/yoloworld/clip/bpe_simple_vocab_16e6.txt.gz differ diff --git a/osam/_models/yoloworld/clip/clip.py b/osam/_models/yoloworld/clip/clip.py new file mode 100644 index 0000000..9824665 --- /dev/null +++ b/osam/_models/yoloworld/clip/clip.py @@ -0,0 +1,32 @@ +# https://github.com/openai/CLIP/blob/main/clip/clip.py + +from typing import List + +import numpy as np + +from .simple_tokenizer import SimpleTokenizer + +_tokenizer = SimpleTokenizer() + + +def tokenize( + texts: List[str], context_length: int = 77, truncate: bool = False +) -> np.ndarray: + sot_token = _tokenizer.encoder["<|startoftext|>"] + eot_token = _tokenizer.encoder["<|endoftext|>"] + all_tokens = [[sot_token] + _tokenizer.encode(text) + [eot_token] for text in texts] + + result = np.zeros((len(all_tokens), context_length), dtype=np.int64) + + for i, tokens in enumerate(all_tokens): + if len(tokens) > context_length: + if truncate: + tokens = tokens[:context_length] + tokens[-1] = eot_token + else: + raise RuntimeError( + f"Input {texts[i]} is too long for context length {context_length}" + ) + result[i, : len(tokens)] = tokens + + return result diff --git a/osam/_models/yoloworld/clip/simple_tokenizer.py b/osam/_models/yoloworld/clip/simple_tokenizer.py new file mode 100644 index 0000000..ccad974 --- /dev/null +++ b/osam/_models/yoloworld/clip/simple_tokenizer.py @@ -0,0 +1,152 @@ +# https://github.com/openai/CLIP/blob/main/clip/simple_tokenizer.py + +import functools +import gzip +import html +import os +import re +from typing import Any +from typing import List + + +@functools.lru_cache() +def default_bpe(): + return os.path.join( + os.path.dirname(os.path.abspath(__file__)), "bpe_simple_vocab_16e6.txt.gz" + ) + + +@functools.lru_cache() +def bytes_to_unicode(): + """ + Returns list of utf-8 byte and a corresponding list of unicode strings. + The reversible bpe codes work on unicode strings. + This means you need a large # of unicode characters in your vocab if you want to avoid UNKs. + When you're at something like a 10B token dataset you end up needing around 5K for decent coverage. + This is a signficant percentage of your normal, say, 32K bpe vocab. + To avoid that, we want lookup tables between utf-8 bytes and unicode strings. + And avoids mapping to whitespace/control characters the bpe code barfs on. + """ # noqa: E501 + bs = ( + list(range(ord("!"), ord("~") + 1)) + + list(range(ord("¡"), ord("¬") + 1)) + + list(range(ord("®"), ord("ÿ") + 1)) + ) + cs = bs[:] + n = 0 + for b in range(2**8): + if b not in bs: + bs.append(b) + cs.append(2**8 + n) + n += 1 + cs = [chr(n) for n in cs] + return dict(zip(bs, cs)) + + +def get_pairs(word): + """Return set of symbol pairs in a word. + Word is represented as tuple of symbols (symbols being variable-length strings). + """ + pairs = set() + prev_char = word[0] + for char in word[1:]: + pairs.add((prev_char, char)) + prev_char = char + return pairs + + +def basic_clean(text): + text = html.unescape(html.unescape(text)) + return text.strip() + + +def whitespace_clean(text): + text = re.sub(r"\s+", " ", text) + text = text.strip() + return text + + +class SimpleTokenizer(object): + def __init__(self, bpe_path: str = default_bpe()): + self.byte_encoder = bytes_to_unicode() + self.byte_decoder = {v: k for k, v in self.byte_encoder.items()} + merges: List[Any] + merges = gzip.open(bpe_path).read().decode("utf-8").split("\n") + merges = merges[1 : 49152 - 256 - 2 + 1] + merges = [tuple(merge.split()) for merge in merges] + vocab = list(bytes_to_unicode().values()) + vocab = vocab + [v + "" for v in vocab] + for merge in merges: + vocab.append("".join(merge)) + vocab.extend(["<|startoftext|>", "<|endoftext|>"]) + self.encoder = dict(zip(vocab, range(len(vocab)))) + self.decoder = {v: k for k, v in self.encoder.items()} + self.bpe_ranks = dict(zip(merges, range(len(merges)))) + self.cache = { + "<|startoftext|>": "<|startoftext|>", + "<|endoftext|>": "<|endoftext|>", + } + self.pat = re.compile( + r"""<\|startoftext\|>|<\|endoftext\|>|'s|'t|'re|'ve|'m|'ll|'d|\w+|\d+|[^\s\w]+""", # noqa: E501 + re.UNICODE | re.IGNORECASE, + ) + + def bpe(self, token): + if token in self.cache: + return self.cache[token] + word = tuple(token[:-1]) + (token[-1] + "",) + pairs = get_pairs(word) + + if not pairs: + return token + "" + + while True: + bigram = min(pairs, key=lambda pair: self.bpe_ranks.get(pair, float("inf"))) + if bigram not in self.bpe_ranks: + break + first, second = bigram + new_word = [] + i = 0 + while i < len(word): + try: + j = word.index(first, i) + new_word.extend(word[i:j]) + i = j + except Exception: + new_word.extend(word[i:]) + break + + if word[i] == first and i < len(word) - 1 and word[i + 1] == second: + new_word.append(first + second) + i += 2 + else: + new_word.append(word[i]) + i += 1 + new_word = tuple(new_word) + word = new_word + if len(word) == 1: + break + else: + pairs = get_pairs(word) + word = " ".join(word) + self.cache[token] = word + return word + + def encode(self, text): + bpe_tokens = [] + text = whitespace_clean(basic_clean(text)).lower() + for token in re.findall(self.pat, text): + token = "".join(self.byte_encoder[b] for b in token.encode("utf-8")) + bpe_tokens.extend( + self.encoder[bpe_token] for bpe_token in self.bpe(token).split(" ") + ) + return bpe_tokens + + def decode(self, tokens): + text = "".join([self.decoder[token] for token in tokens]) + text = ( + bytearray([self.byte_decoder[c] for c in text]) + .decode("utf-8", errors="replace") + .replace("", " ") + ) + return text diff --git a/osam/_server.py b/osam/_server.py index 28cf33b..67a0bb1 100644 --- a/osam/_server.py +++ b/osam/_server.py @@ -2,8 +2,9 @@ import os import fastapi -from osam_core import apis -from osam_core import types + +from . import apis +from . import types app: fastapi.FastAPI = fastapi.FastAPI() diff --git a/osam/apis.py b/osam/apis.py index 5f37522..24c8f62 100644 --- a/osam/apis.py +++ b/osam/apis.py @@ -1 +1,44 @@ -from osam_core.apis import * # noqa: F403 +from typing import List +from typing import Optional +from typing import Type + +from . import _models +from . import types + +running_model: Optional[types.Model] = None + +registered_model_types: List[Type] = [ + _models.EfficientSam10m, + _models.EfficientSam30m, + _models.Sam100m, + _models.Sam300m, + _models.Sam600m, + _models.YoloWorldXL, +] + + +def get_model_type_by_name(name: str) -> Type: + model_name: str + if ":" in name: + model_name = name + else: + model_name = f"{name}:latest" + + for cls in registered_model_types: + if cls.name == model_name: + break + else: + raise ValueError(f"Model {name!r} not found.") + return cls + + +def generate(request: types.GenerateRequest) -> types.GenerateResponse: + global running_model + + model_type = get_model_type_by_name(name=request.model) + if running_model is None or running_model.name != model_type.name: + running_model = model_type() + assert running_model is not None + + response: types.GenerateResponse = running_model.generate(request=request) + return response diff --git a/osam/apis_test.py b/osam/apis_test.py new file mode 100644 index 0000000..e69de29 diff --git a/osam/types.py b/osam/types.py deleted file mode 100644 index d077ed8..0000000 --- a/osam/types.py +++ /dev/null @@ -1 +0,0 @@ -from osam_core.types import * # noqa: F403 diff --git a/osam/types/__init__.py b/osam/types/__init__.py new file mode 100644 index 0000000..4b8bebe --- /dev/null +++ b/osam/types/__init__.py @@ -0,0 +1,26 @@ +import warnings + +from ._annotation import Annotation # noqa: F401 +from ._blob import Blob # noqa: F401 +from ._bounding_box import BoundingBox # noqa: F401 +from ._generate import GenerateRequest # noqa: F401 +from ._generate import GenerateResponse # noqa: F401 +from ._image_embedding import ImageEmbedding # noqa: F401 +from ._model import Model # noqa: F401 +from ._prompt import Prompt # noqa: F401 + + +class ModelBase(Model): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + warnings.warning( + "This class is deprecated, use `Model` instead.", DeprecationWarning + ) + + +class ModelBlob(Blob): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + warnings.warning( + "This class is deprecated, use `Blob` instead.", DeprecationWarning + ) diff --git a/osam/types/_annotation.py b/osam/types/_annotation.py new file mode 100644 index 0000000..cbde3fd --- /dev/null +++ b/osam/types/_annotation.py @@ -0,0 +1,30 @@ +from typing import Optional + +import numpy as np +import pydantic + +from .. import _json +from ._bounding_box import BoundingBox + + +class Annotation(pydantic.BaseModel): + model_config = pydantic.ConfigDict(arbitrary_types_allowed=True) + + bounding_box: Optional[BoundingBox] = pydantic.Field(default=None) + text: Optional[str] = pydantic.Field(default=None) + score: Optional[float] = pydantic.Field(default=None) + mask: Optional[np.ndarray] = pydantic.Field(default=None) + + @pydantic.field_validator("mask") + def validate_mask(cls, mask: Optional[np.ndarray]) -> Optional[np.ndarray]: + if mask is None: + return None + if mask.dtype != bool: + raise ValueError("mask must be boolean arrays") + return mask + + @pydantic.field_serializer("mask") + def serialize_mask(self, mask: Optional[np.ndarray]) -> Optional[str]: + if mask is None: + return None + return _json.image_ndarray_to_b64data(ndarray=mask.view(np.uint8) * 255) diff --git a/osam/types/_blob.py b/osam/types/_blob.py new file mode 100644 index 0000000..34e01b2 --- /dev/null +++ b/osam/types/_blob.py @@ -0,0 +1,39 @@ +import dataclasses +import os + +import gdown +from loguru import logger + + +@dataclasses.dataclass +class Blob: + url: str + hash: str + + @property + def path(self): + return os.path.expanduser(f"~/.cache/osam/models/blobs/{self.hash}") + + @property + def size(self): + if os.path.exists(self.path): + return os.stat(self.path).st_size + else: + return None + + @property + def modified_at(self): + if os.path.exists(self.path): + return os.stat(self.path).st_mtime + else: + return None + + def pull(self): + gdown.cached_download(url=self.url, path=self.path, hash=self.hash) + + def remove(self): + if os.path.exists(self.path): + logger.debug("Removing blob {path!r}", path=self.path) + os.remove(self.path) + else: + logger.warning("Blob {path!r} not found", path=self.path) diff --git a/osam/types/_bounding_box.py b/osam/types/_bounding_box.py new file mode 100644 index 0000000..1915f0c --- /dev/null +++ b/osam/types/_bounding_box.py @@ -0,0 +1,8 @@ +import pydantic + + +class BoundingBox(pydantic.BaseModel): + xmin: int + ymin: int + xmax: int + ymax: int diff --git a/osam/types/_generate.py b/osam/types/_generate.py new file mode 100644 index 0000000..5f4ea8e --- /dev/null +++ b/osam/types/_generate.py @@ -0,0 +1,38 @@ +from typing import List +from typing import Optional +from typing import Union + +import numpy as np +import pydantic + +from .. import _json +from ._annotation import Annotation +from ._image_embedding import ImageEmbedding +from ._prompt import Prompt + + +class GenerateRequest(pydantic.BaseModel): + model_config = pydantic.ConfigDict(arbitrary_types_allowed=True) + + model: str + image_embedding: Optional[ImageEmbedding] = pydantic.Field(default=None) + image: Optional[np.ndarray] = pydantic.Field(default=None) + prompt: Optional[Prompt] = pydantic.Field(default=None) + annotations: Optional[List[Annotation]] = pydantic.Field(default=None) + + @pydantic.field_validator("image", mode="before") + @classmethod + def validate_image( + cls, image: Optional[Union[str, np.ndarray]] + ) -> Optional[np.ndarray]: + if isinstance(image, str): + return _json.image_b64data_to_ndarray(b64data=image) + return image + + +class GenerateResponse(pydantic.BaseModel): + model_config = pydantic.ConfigDict(arbitrary_types_allowed=True) + + model: str + image_embedding: Optional[ImageEmbedding] = pydantic.Field(default=None) + annotations: List[Annotation] diff --git a/osam/types/_image_embedding.py b/osam/types/_image_embedding.py new file mode 100644 index 0000000..915b3e4 --- /dev/null +++ b/osam/types/_image_embedding.py @@ -0,0 +1,24 @@ +from typing import List + +import numpy as np +import pydantic + + +class ImageEmbedding(pydantic.BaseModel): + model_config = pydantic.ConfigDict(arbitrary_types_allowed=True) + + original_height: int + original_width: int + embedding: np.ndarray + + @pydantic.field_validator("embedding") + def validate_embedding(cls, embedding): + if embedding.ndim != 3: + raise ValueError( + "embedding must be 3-dimensional: (embedding_dim, height, width)" + ) + return embedding + + @pydantic.field_serializer("embedding") + def serialize_embedding(self, embedding: np.ndarray) -> List[List[List[float]]]: + return embedding.tolist() diff --git a/osam/types/_model.py b/osam/types/_model.py new file mode 100644 index 0000000..0764618 --- /dev/null +++ b/osam/types/_model.py @@ -0,0 +1,102 @@ +import hashlib +from typing import Dict +from typing import Optional + +import numpy as np +import onnxruntime +from loguru import logger + +from .. import _contextlib +from ._blob import Blob +from ._generate import GenerateRequest +from ._generate import GenerateResponse +from ._image_embedding import ImageEmbedding + + +class Model: + name: str + + _blobs: Dict[str, Blob] + _inference_sessions: Dict[str, onnxruntime.InferenceSession] + + def __init__(self): + logger.debug("Initializing model {name}", name=self.name) + + self.pull() + + providers = None + self._inference_sessions = {} + for key, blob in self._blobs.items(): + try: + # Try to use all of the available providers e.g., cuda, tensorrt. + if providers is None: + if "CUDAExecutionProvider" in onnxruntime.get_available_providers(): + providers = ["CUDAExecutionProvider", "CPUExecutionProvider"] + else: + providers = ["CPUExecutionProvider"] + # Suppress all the error messages from the missing providers. + with _contextlib.suppress(): + inference_session = onnxruntime.InferenceSession( + blob.path, providers=providers + ) + except Exception as e: + # Even though there is fallback in onnxruntime, it won't always work. + # e.g., CUDA is installed and CUDA_PATH is set, but CUDA_VISIBLE_DEVICES + # is empty. We fallback to cpu in such cases. + logger.error( + "Failed to create inference session with providers {providers!r}. " + "Falling back to ['CPUExecutionProvider']", + providers=providers, + e=e, + ) + providers = ["CPUExecutionProvider"] + inference_session = onnxruntime.InferenceSession( + blob.path, providers=providers + ) + self._inference_sessions[key] = inference_session + + providers = inference_session.get_providers() + logger.info( + "Initialized inference sessions with providers {providers!r}", + providers=providers, + ) + + @classmethod + def pull(cls): + for blob in cls._blobs.values(): + blob.pull() + + @classmethod + def remove(cls): + for blob in cls._blobs.values(): + blob.remove() + + @classmethod + def get_id(cls) -> str: + return hashlib.md5( + "+".join(blob.hash for blob in cls._blobs.values()).encode() + ).hexdigest()[:12] + + @classmethod + def get_size(cls) -> Optional[int]: + size = 0 + for blob in cls._blobs.values(): + if blob.size is None: + return None + size += blob.size + return size + + @classmethod + def get_modified_at(cls) -> Optional[float]: + modified_at = 0 + for blob in cls._blobs.values(): + if blob.modified_at is None: + return None + modified_at = max(modified_at, blob.modified_at) + return modified_at + + def encode_image(self, image: np.ndarray) -> ImageEmbedding: + raise NotImplementedError + + def generate(self, request: GenerateRequest) -> GenerateResponse: + raise NotImplementedError diff --git a/osam/types/_prompt.py b/osam/types/_prompt.py new file mode 100644 index 0000000..f2b20ae --- /dev/null +++ b/osam/types/_prompt.py @@ -0,0 +1,67 @@ +from typing import List +from typing import Optional +from typing import Type +from typing import Union + +import numpy as np +import pydantic + + +class Prompt(pydantic.BaseModel): + model_config = pydantic.ConfigDict(arbitrary_types_allowed=True) + + points: Optional[np.ndarray] = pydantic.Field(default=None) + point_labels: Optional[np.ndarray] = pydantic.Field(default=None) + texts: Optional[List[str]] = pydantic.Field(default=None) + + iou_threshold: Optional[float] = pydantic.Field(default=0.5) + score_threshold: Optional[float] = pydantic.Field(default=0.1) + max_annotations: Optional[int] = pydantic.Field(default=100) + + @pydantic.field_serializer("points") + def _serialize_points(self: "Prompt", points: np.ndarray) -> List[List[float]]: + return points.tolist() + + @pydantic.field_serializer("point_labels") + def _serialize_point_labels(self: "Prompt", point_labels: np.ndarray) -> List[int]: + return point_labels.tolist() + + @pydantic.field_validator("points", mode="before") + @classmethod + def _validate_points(cls: Type, points: Union[list, np.ndarray]): + if isinstance(points, list): + points = np.array(points, dtype=float) + if points.ndim != 2: + raise ValueError("points must be 2-dimensional") + if points.shape[1] != 2: + raise ValueError("points must have 2 columns") + return points + + @pydantic.field_validator("point_labels", mode="before") + @classmethod + def _validate_point_labels(cls: Type, point_labels: Union[list, np.ndarray]): + if isinstance(point_labels, list): + point_labels = np.array(point_labels, dtype=int) + if point_labels.ndim != 1: + raise ValueError("point_labels must be 1-dimensional") + if not set(np.unique(point_labels).tolist()).issubset({0, 1, 2, 3}): + raise ValueError("point_labels must contain only 0, 1, 2, or 3") + return point_labels + + @pydantic.model_validator(mode="after") + def _validate_prompt(self) -> "Prompt": + if self.points is None and self.point_labels is None: + if self.texts is None: + raise ValueError( + "texts must be provided when points and point_labels " + "are not provided" + ) + elif ( + self.points is None + or self.point_labels is None + or self.points.shape[0] != self.point_labels.shape[0] + ): + raise ValueError( + "points and point_labels must have the same number of rows" + ) + return self diff --git a/pyproject.toml b/pyproject.toml index e82b9fe..724e7aa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,14 +31,13 @@ classifiers = [ ] dependencies = [ "click", + "gdown", "fastapi", "imgviz", "loguru", - "osam-core", - "osam-efficientsam", - "osam-sam", - "osam-yoloworld", + "onnxruntime", "Pillow", + "pydantic", "uvicorn", ] dynamic = ["readme", "version"]