diff --git a/.gitignore b/.gitignore index b36b383..0ed34a3 100644 --- a/.gitignore +++ b/.gitignore @@ -27,4 +27,6 @@ __pycache__/ .coverage # .vscode -.vscode/ \ No newline at end of file +.vscode/ + +dist/ \ No newline at end of file diff --git a/detectors/Dockerfile.hf b/detectors/Dockerfile.hf index abc74c0..58e02fa 100644 --- a/detectors/Dockerfile.hf +++ b/detectors/Dockerfile.hf @@ -6,26 +6,19 @@ RUN microdnf update -y && \ microdnf clean all RUN pip install --no-cache-dir torch -# FROM icr.io/fm-stack/ubi9-minimal-py39-torch as builder FROM base as builder -COPY ./common/requirements.txt . -RUN pip install --no-cache-dir -r requirements.txt - -COPY ./huggingface/requirements.txt . -RUN pip install --no-cache-dir -r requirements.txt +RUN pip install --no-cache-dir \ + guardrails-detector-common \ + guardrails-detector-huggingface FROM builder WORKDIR /app -ARG CACHEBUST=1 -RUN echo "$CACHEBUST" -COPY ./common /common -COPY ./huggingface/app.py /app -COPY ./huggingface/detector.py /app -COPY ./huggingface/scheme.py /app + +# COPY tests/dummy_models /app/models +# ENV MODEL_DIR=/app/models/bert/BertForSequenceClassification EXPOSE 8000 -CMD ["uvicorn", "app:app", "--workers", "4", "--host", "0.0.0.0", "--port", "8000", "--log-config", "/common/log_conf.yaml"] -# gunicorn main:app --workers 4 --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:8000 \ No newline at end of file +CMD ["python", "-m", "uvicorn", "guardrails_detector_huggingface.app:app", "--workers", "4", "--host", "0.0.0.0", "--port", "8000"] \ No newline at end of file diff --git a/detectors/built_in/app.py b/detectors/built_in/app.py index 9ec7fca..357b9d5 100644 --- a/detectors/built_in/app.py +++ b/detectors/built_in/app.py @@ -5,8 +5,8 @@ from file_type_detectors import FileTypeDetectorRegistry from prometheus_fastapi_instrumentator import Instrumentator -from detectors.common.scheme import ContentAnalysisHttpRequest, ContentsAnalysisResponse -from detectors.common.app import DetectorBaseAPI as FastAPI +from guardrails_detector_common import ContentAnalysisHttpRequest, ContentsAnalysisResponse +from guardrails_detector_common import DetectorBaseAPI as FastAPI @asynccontextmanager async def lifespan(app: FastAPI): diff --git a/detectors/built_in/base_detector_registry.py b/detectors/built_in/base_detector_registry.py index 8ece51a..2a6c7e7 100644 --- a/detectors/built_in/base_detector_registry.py +++ b/detectors/built_in/base_detector_registry.py @@ -1,7 +1,7 @@ from abc import ABC, abstractmethod from typing import List -from detectors.common.scheme import ContentAnalysisResponse +from guardrails_detector_common import ContentAnalysisResponse class BaseDetectorRegistry(ABC): def __init__(self): diff --git a/detectors/built_in/file_type_detectors.py b/detectors/built_in/file_type_detectors.py index 58de98d..2592cce 100644 --- a/detectors/built_in/file_type_detectors.py +++ b/detectors/built_in/file_type_detectors.py @@ -9,7 +9,7 @@ from typing import List, Optional from base_detector_registry import BaseDetectorRegistry -from detectors.common.scheme import ContentAnalysisResponse +from guardrails_detector_common import ContentAnalysisResponse def is_valid_json(s: str) -> Optional[ContentAnalysisResponse]: diff --git a/detectors/built_in/regex_detectors.py b/detectors/built_in/regex_detectors.py index f4a1b6d..5e9229f 100644 --- a/detectors/built_in/regex_detectors.py +++ b/detectors/built_in/regex_detectors.py @@ -2,7 +2,7 @@ from http.client import HTTPException from typing import List from base_detector_registry import BaseDetectorRegistry -from detectors.common.scheme import ContentAnalysisResponse +from guardrails_detector_common import ContentAnalysisResponse def email_address_detector(string: str) -> List[ContentAnalysisResponse]: diff --git a/detectors/built_in/requirements-dev.txt b/detectors/built_in/requirements-dev.txt new file mode 100644 index 0000000..5172860 --- /dev/null +++ b/detectors/built_in/requirements-dev.txt @@ -0,0 +1,4 @@ +-e ../common/ +markdown==3.8.2 +jsonschema==4.24.0 +xmlschema==4.1.0 \ No newline at end of file diff --git a/detectors/built_in/requirements.txt b/detectors/built_in/requirements.txt index 31144c9..6283b35 100644 --- a/detectors/built_in/requirements.txt +++ b/detectors/built_in/requirements.txt @@ -1,3 +1,4 @@ markdown==3.8.2 jsonschema==4.24.0 -xmlschema==4.1.0 \ No newline at end of file +xmlschema==4.1.0 +guardrails-detector-common>=0.1.0 \ No newline at end of file diff --git a/detectors/common/LICENSE b/detectors/common/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/detectors/common/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/detectors/common/README.md b/detectors/common/README.md new file mode 100644 index 0000000..a8b006e --- /dev/null +++ b/detectors/common/README.md @@ -0,0 +1,21 @@ +# Guardrails Detectors Common + +Common utilities and base classes for guardrails detector packages. + +## Overview + +This package provides components used by all guardrails detector packages: + +- **FastAPI Base Classes**: `DetectorBaseAPI` for creating detector web services +- **Logging**: Configured logger instance for consistent logging across detectors +- **Data Models**: Shared Pydantic models for request/response schemas + +## Installation + +```bash +pip install guardrails-detector-common +``` + +## License + +Apache-2.0 \ No newline at end of file diff --git a/detectors/common/__init__.py b/detectors/common/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/detectors/common/pyproject.toml b/detectors/common/pyproject.toml new file mode 100644 index 0000000..89d085a --- /dev/null +++ b/detectors/common/pyproject.toml @@ -0,0 +1,62 @@ +[project] +name = "guardrails-detector-common" +version = "0.1.0" +description = "Common utilities and base classes for guardrails detectors" +readme = "README.md" +requires-python = ">=3.9" +license = { text = "Apache-2.0" } +authors = [ + {name = "Mac Misiura", email = "mmisiura@redhat.com"}, + {name = "Rob Geada", email = "rgeada@redhat.com"}, + {name = "Rui Vieira", email = "rcardoso@redhat.com"}, + {name = "Sai Chandra", email = "spandraj@redhat.com"}, + {name = "TrustyAI team"} +] +classifiers = [ + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "License :: OSI Approved :: Apache Software License", + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "Topic :: Scientific/Engineering :: Artificial Intelligence", + "Topic :: Software Development :: Libraries :: Python Modules", +] +keywords = ["AI", "LLM", "Guardrails", "Detectors", "Responsible AI", "TrustyAI"] + +dependencies = [ + "fastapi>=0.112.0", + "uvicorn>=0.30.5", + "httpx>=0.27.0", + "prometheus-client>=0.18.0", + "prometheus-fastapi-instrumentator>=7.0.0", + "PyYAML>=6.0.2", + "pydantic>=2.0.0", +] + +[project.optional-dependencies] +dev = [ + "build", + "pytest>=8.3.2", + "pre-commit>=3.8.0", +] + +[project.urls] +Homepage = "https://github.com/trustyai-explainability/guardrails-detectors" +Repository = "https://github.com/trustyai-explainability/guardrails-detectors.git" +Issues = "https://github.com/trustyai-explainability/guardrails-detectors/issues" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.hatch.build.targets.wheel] +packages = ["src/guardrails_detector_common"] + +[tool.hatch.build.targets.sdist] +include = [ + "src/", + "pyproject.toml", + "README.md", + "LICENSE" +] \ No newline at end of file diff --git a/detectors/common/src/guardrails_detector_common/__init__.py b/detectors/common/src/guardrails_detector_common/__init__.py new file mode 100644 index 0000000..4fcdebb --- /dev/null +++ b/detectors/common/src/guardrails_detector_common/__init__.py @@ -0,0 +1,52 @@ +""" +Guardrails Detectors Common +""" + +from .app import DetectorBaseAPI, logger +from .scheme import ( + RoleEnum, + Message, + TextDetectionHttpRequest, + TextDetectionResponse, + GenerationDetectionHttpRequest, + GenerationDetectionResponse, + ChatDetectionHttpRequest, + ContextBasedDetectionHttpRequest, + AttributionBasedDetectionResponse, + DetectionHttpRequest, + DetectionResponseSpan, + DetectionResponse, + Evidence, + EvidenceType, + EvidenceObj, + ContentAnalysisHttpRequest, + ContentAnalysisResponse, + ContentsAnalysisResponse, + Error, +) + +__version__ = "0.1.0" + +__all__ = [ + "DetectorBaseAPI", + "logger", + "RoleEnum", + "Message", + "TextDetectionHttpRequest", + "TextDetectionResponse", + "GenerationDetectionHttpRequest", + "GenerationDetectionResponse", + "ChatDetectionHttpRequest", + "ContextBasedDetectionHttpRequest", + "AttributionBasedDetectionResponse", + "DetectionHttpRequest", + "DetectionResponseSpan", + "DetectionResponse", + "Evidence", + "EvidenceType", + "EvidenceObj", + "ContentAnalysisHttpRequest", + "ContentAnalysisResponse", + "ContentsAnalysisResponse", + "Error", +] diff --git a/detectors/common/app.py b/detectors/common/src/guardrails_detector_common/app.py similarity index 99% rename from detectors/common/app.py rename to detectors/common/src/guardrails_detector_common/app.py index 0ae8e23..216ecd8 100644 --- a/detectors/common/app.py +++ b/detectors/common/src/guardrails_detector_common/app.py @@ -8,8 +8,6 @@ from fastapi.exceptions import RequestValidationError from fastapi.responses import JSONResponse -sys.path.insert(0, os.path.abspath("..")) - import logging from fastapi import FastAPI, status diff --git a/detectors/common/log_conf.yaml b/detectors/common/src/guardrails_detector_common/log_conf.yaml similarity index 100% rename from detectors/common/log_conf.yaml rename to detectors/common/src/guardrails_detector_common/log_conf.yaml diff --git a/detectors/common/scheme.py b/detectors/common/src/guardrails_detector_common/scheme.py similarity index 100% rename from detectors/common/scheme.py rename to detectors/common/src/guardrails_detector_common/scheme.py diff --git a/detectors/huggingface/LICENSE b/detectors/huggingface/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/detectors/huggingface/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/detectors/huggingface/__init__.py b/detectors/huggingface/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/detectors/huggingface/pyproject.toml b/detectors/huggingface/pyproject.toml new file mode 100644 index 0000000..d597620 --- /dev/null +++ b/detectors/huggingface/pyproject.toml @@ -0,0 +1,57 @@ +[project] +name = "guardrails-detector-huggingface" +version = "0.1.1" +description = "Huggingface detector implementation for guardrails" +readme = "README.md" +requires-python = ">=3.9" +license = { text = "Apache-2.0" } +authors = [ + {name = "Mac Misiura", email = "mmisiura@redhat.com"}, + {name = "Rob Geada", email = "rgeada@redhat.com"}, + {name = "Rui Vieira", email = "rcardoso@redhat.com"}, + {name = "Sai Chandra", email = "spandraj@redhat.com"}, + {name = "TrustyAI team"} +] +classifiers = [ + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "License :: OSI Approved :: Apache Software License", + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "Topic :: Scientific/Engineering :: Artificial Intelligence", + "Topic :: Software Development :: Libraries :: Python Modules", +] +keywords = ["AI", "LLM", "Guardrails", "Responsible AI", "TrustyAI", "Huggingface", "Transformers"] +dependencies = [ + "guardrails-detector-common>=0.1.0", + "transformers>=4.50.0", + "torch>=1.13.0", +] + +[project.optional-dependencies] +dev = [ + "build", + "pytest>=8.3.2", + "pre-commit>=3.8.0", +] + +[project.urls] +Homepage = "https://github.com/trustyai-explainability/guardrails-detectors" +Repository = "https://github.com/trustyai-explainability/guardrails-detectors.git" +Issues = "https://github.com/trustyai-explainability/guardrails-detectors/issues" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.hatch.build.targets.wheel] +packages = ["src/guardrails_detector_huggingface"] + +[tool.hatch.build.targets.sdist] +include = [ + "src/", + "pyproject.toml", + "README.md", + "LICENSE" +] diff --git a/detectors/huggingface/requirements-dev.txt b/detectors/huggingface/requirements-dev.txt new file mode 100644 index 0000000..a67abed --- /dev/null +++ b/detectors/huggingface/requirements-dev.txt @@ -0,0 +1,2 @@ +-e ../common/ +transformers==4.50.0 diff --git a/detectors/huggingface/requirements.txt b/detectors/huggingface/requirements.txt index 20d5940..6b3b606 100644 --- a/detectors/huggingface/requirements.txt +++ b/detectors/huggingface/requirements.txt @@ -1 +1,2 @@ transformers==4.50.0 +guardrails-detector-common>=0.1.0 diff --git a/detectors/huggingface/src/guardrails_detector_huggingface/__init__.py b/detectors/huggingface/src/guardrails_detector_huggingface/__init__.py new file mode 100644 index 0000000..b48224a --- /dev/null +++ b/detectors/huggingface/src/guardrails_detector_huggingface/__init__.py @@ -0,0 +1,23 @@ +""" +Huggingface Guardrails Detector +""" + +from .detector import Detector +from .app import app +from .scheme import ( + ContentAnalysisHttpRequest, + ContentAnalysisResponse, + ContentsAnalysisResponse, + Error, +) + +__version__ = "0.1.0" + +__all__ = [ + "Detector", + "app", + "ContentAnalysisHttpRequest", + "ContentAnalysisResponse", + "ContentsAnalysisResponse", + "Error", +] diff --git a/detectors/huggingface/app.py b/detectors/huggingface/src/guardrails_detector_huggingface/app.py similarity index 89% rename from detectors/huggingface/app.py rename to detectors/huggingface/src/guardrails_detector_huggingface/app.py index 8ff1213..186924b 100644 --- a/detectors/huggingface/app.py +++ b/detectors/huggingface/src/guardrails_detector_huggingface/app.py @@ -1,15 +1,12 @@ -import os -import sys from contextlib import asynccontextmanager from typing import Annotated from fastapi import Header from prometheus_fastapi_instrumentator import Instrumentator -sys.path.insert(0, os.path.abspath("..")) -from common.app import DetectorBaseAPI as FastAPI -from detector import Detector -from scheme import ( +from guardrails_detector_common import DetectorBaseAPI as FastAPI +from .detector import Detector +from .scheme import ( ContentAnalysisHttpRequest, ContentsAnalysisResponse, Error, diff --git a/detectors/huggingface/detector.py b/detectors/huggingface/src/guardrails_detector_huggingface/detector.py similarity index 99% rename from detectors/huggingface/detector.py rename to detectors/huggingface/src/guardrails_detector_huggingface/detector.py index b6b070f..57848d7 100644 --- a/detectors/huggingface/detector.py +++ b/detectors/huggingface/src/guardrails_detector_huggingface/detector.py @@ -1,7 +1,4 @@ import os -import sys - -sys.path.insert(0, os.path.abspath("..")) import math import torch from transformers import ( @@ -10,8 +7,8 @@ AutoModelForSequenceClassification, AutoModelForCausalLM, ) -from common.app import logger -from scheme import ( +from guardrails_detector_common import logger +from .scheme import ( ContentAnalysisHttpRequest, ContentAnalysisResponse, ContentsAnalysisResponse, diff --git a/detectors/huggingface/scheme.py b/detectors/huggingface/src/guardrails_detector_huggingface/scheme.py similarity index 100% rename from detectors/huggingface/scheme.py rename to detectors/huggingface/src/guardrails_detector_huggingface/scheme.py diff --git a/detectors/llm_judge/app.py b/detectors/llm_judge/app.py index 1eb7d0c..2e387d2 100644 --- a/detectors/llm_judge/app.py +++ b/detectors/llm_judge/app.py @@ -4,7 +4,7 @@ from fastapi import Header, HTTPException from prometheus_fastapi_instrumentator import Instrumentator -from detectors.common.app import DetectorBaseAPI as FastAPI +from guardrails_detector_common import DetectorBaseAPI as FastAPI from detectors.llm_judge.detector import LLMJudgeDetector from detectors.llm_judge.scheme import ( ContentAnalysisHttpRequest, diff --git a/detectors/llm_judge/detector.py b/detectors/llm_judge/detector.py index 823a2f7..27d2de4 100644 --- a/detectors/llm_judge/detector.py +++ b/detectors/llm_judge/detector.py @@ -3,7 +3,7 @@ from vllm_judge import Judge, EvaluationResult, BUILTIN_METRICS from vllm_judge.exceptions import MetricNotFoundError -from detectors.common.app import logger +from guardrails_detector_common import logger from detectors.llm_judge.scheme import ( ContentAnalysisHttpRequest, ContentAnalysisResponse, diff --git a/detectors/llm_judge/requirements-dev.txt b/detectors/llm_judge/requirements-dev.txt new file mode 100644 index 0000000..136cc89 --- /dev/null +++ b/detectors/llm_judge/requirements-dev.txt @@ -0,0 +1,3 @@ +-e ../common/ +vllm-judge[jinja2]==0.1.6 +pyyaml==6.0.2 \ No newline at end of file diff --git a/detectors/llm_judge/requirements.txt b/detectors/llm_judge/requirements.txt index ac1cc6c..7a89d71 100644 --- a/detectors/llm_judge/requirements.txt +++ b/detectors/llm_judge/requirements.txt @@ -1,2 +1,3 @@ vllm-judge[jinja2]==0.1.6 -pyyaml==6.0.2 \ No newline at end of file +pyyaml==6.0.2 +guardrails-detector-common>=0.1.0 \ No newline at end of file