From fa6dbc5c1d428cdbb83ce7bec36c074b7579c1d1 Mon Sep 17 00:00:00 2001 From: "Kenneth S." Date: Mon, 4 Aug 2025 18:57:44 -0700 Subject: [PATCH] Add semantic search models with Git LFS - Configure Git LFS to track models/*.zip files - Add semantic-models.zip (83MB) containing all-MiniLM-L6-v2 model - Include Apache 2.0 LICENSE for proper license compliance - Add NOTICE file with copyright attribution - Add README.md with usage instructions and license information This enables offline semantic search functionality while maintaining repository performance through Git LFS. Restructure models with individual zip files per model --- .gitattributes | 5 +- models/LICENSE | 176 ++++++++++++++++++++++++++++++++++++ models/NOTICE | 26 ++++++ models/README.md | 59 ++++++++++++ models/all-MiniLM-L6-v2.zip | 3 + 5 files changed, 268 insertions(+), 1 deletion(-) create mode 100644 models/LICENSE create mode 100644 models/NOTICE create mode 100644 models/README.md create mode 100644 models/all-MiniLM-L6-v2.zip diff --git a/.gitattributes b/.gitattributes index 8b308c4cc6..98e7be44bf 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,4 +1,7 @@ *.rs text eol=lf Cargo.toml text eol=lf Cargo.lock text eol=lf -.gitignore text eol=lf \ No newline at end of file +.gitignore text eol=lf + +# Git LFS tracking for model files +models/*.zip filter=lfs diff=lfs merge=lfs -text \ No newline at end of file diff --git a/models/LICENSE b/models/LICENSE new file mode 100644 index 0000000000..6c850479a4 --- /dev/null +++ b/models/LICENSE @@ -0,0 +1,176 @@ + 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 use, 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 diff --git a/models/NOTICE b/models/NOTICE new file mode 100644 index 0000000000..e68f25078f --- /dev/null +++ b/models/NOTICE @@ -0,0 +1,26 @@ +Amazon Q Developer CLI - Models +Copyright 2024 Amazon Web Services, Inc. + +This product includes software developed by third parties: + +================================================================================ + +all-MiniLM-L6-v2 Model +Copyright 2019 Sentence Transformers + +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. + +Source: https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2 +Purpose: Semantic search and text embeddings for Amazon Q Developer CLI + +================================================================================ diff --git a/models/README.md b/models/README.md new file mode 100644 index 0000000000..791be47719 --- /dev/null +++ b/models/README.md @@ -0,0 +1,59 @@ +# Models + +This directory contains machine learning models used by Amazon Q Developer CLI. + +## Models Included + +### all-MiniLM-L6-v2.zip +- **Purpose**: Semantic search and text embeddings for Amazon Q Developer CLI +- **Contains**: all-MiniLM-L6-v2 model from Hugging Face +- **Source**: [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) +- **License**: Apache 2.0 (see LICENSE file) +- **Size**: ~83MB compressed +- **Usage**: Used for semantic code search and similarity matching + +## Adding New Models + +To add additional models: + +1. Create a new zip file named after the model (e.g., `model-name.zip`) +2. Git LFS will automatically track all `.zip` files in this directory +3. Update this README with model information +4. Ensure proper license compliance + +## License Compliance + +This directory contains third-party software licensed under the Apache License 2.0. +All license requirements are met as follows: + +1. **License Copy**: The full Apache 2.0 license text is provided in the LICENSE file +2. **Copyright Notice**: Original copyright notices are preserved +3. **Attribution**: Proper attribution is provided in NOTICE file +4. **Modification Notice**: Any modifications are clearly documented + +## Git LFS + +Model files are stored using Git LFS. To download the actual model files: + +```bash +git lfs pull +``` + +## Files in this directory + +- `all-MiniLM-L6-v2.zip` - The all-MiniLM-L6-v2 model files (tracked by Git LFS) +- `LICENSE` - Full Apache 2.0 license text +- `NOTICE` - Attribution and copyright notices +- `README.md` - This file + +## Usage + +Extract the model files to your local semantic search cache directory: + +```bash +# Extract all-MiniLM-L6-v2 model +unzip models/all-MiniLM-L6-v2.zip -d ~/.semantic_search/models/all-MiniLM-L6-v2/ +``` + +These models are redistributed in compliance with the Apache 2.0 license terms. +See the LICENSE file for full terms and conditions. diff --git a/models/all-MiniLM-L6-v2.zip b/models/all-MiniLM-L6-v2.zip new file mode 100644 index 0000000000..e99675711c --- /dev/null +++ b/models/all-MiniLM-L6-v2.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1df18f494ec0a30d1ef4bc7ae12c560e9699e401f0a0d1dc0e50acd5fca05db2 +size 83316898