1.3.0

Breaking Changes

Minimum Python Version Requirement in #573

• Now requires Python 3.11 or higher
• Previous versions supported Python 3.8+
• If using older Python version, please upgrade before installing

What's Changed

• Add space type mapping for sentence transformer models by @nathaliellenaa in #512
• Update Model Upload History - sentence-transformers/all-MiniLM-L6-v2 (v.1.0.2)(BOTH) by @github-actions[bot] in #523
• Update Model Upload History - sentence-transformers/all-MiniLM-L12-v2 (v.1.0.2)(BOTH) by @github-actions[bot] in #526
• Update Model Upload History - sentence-transformers/multi-qa-MiniLM-L6-cos-v1 (v.1.0.2)(BOTH) by @github-actions[bot] in #528
• Update Model Upload History - sentence-transformers/paraphrase-MiniLM-L3-v2 (v.1.0.2)(BOTH) by @github-actions[bot] in #530
• Update Model Upload History - sentence-transformers/msmarco-distilbert-base-tas-b (v.1.0.3)(BOTH) by @github-actions[bot] in #532
• Increase timeout in OPENSEARCH_TEST_CLIENT by @nathaliellenaa in #533
• Update Model Upload History - sentence-transformers/all-distilroberta-v1 (v.1.0.2)(BOTH) by @github-actions[bot] in #535
• Update Model Upload History - sentence-transformers/all-mpnet-base-v2 (v.1.0.2)(BOTH) by @github-actions[bot] in #537
• Update Model Upload History - sentence-transformers/multi-qa-mpnet-base-dot-v1 (v.1.0.2)(BOTH) by @github-actions[bot] in #539
• Update Model Upload History - sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2 (v.1.0.2)(BOTH) by @github-actions[bot] in #541
• Update Model Upload History - sentence-transformers/paraphrase-mpnet-base-v2 (v.1.0.1)(BOTH) by @github-actions[bot] in #543
• Update Model Upload History - sentence-transformers/distiluse-base-multilingual-cased-v1 (v.1.0.2)(TORCH_SCRIPT) by @github-actions[bot] in #545
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-doc-v2-distill (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #415
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-doc-v3-distill (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #483
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-multilingual-v1 (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #485
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-doc-v3-distill (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #489
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-doc-v3-distill (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #492
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-multilingual-v1 (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #494
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-multilingual-v1 (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #496
• Update Model Upload History - opensearch-project/opensearch-semantic-highlighter-v1 (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #499
• Update Model Upload History - opensearch-project/opensearch-semantic-highlighter-v1 (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #503
• Update Pretrained Model Listing - 2025-06-02 17:57:40 by @github-actions[bot] in #547
• Update Pretrained Model Listing by @nathaliellenaa in #548
• Increment version and update changelog by @nathaliellenaa in #519
• Add script for deploying semantic highlighter model on sagemaker by @junqiu-lei in #513
• Update Model Upload History - opensearch-project/opensearch-semantic-highlighter-v1 (v.1.0.0)(TORCH_SCRIPT) by @github-actions[bot] in #550
• #552: Fix for uploading models with function_name instead of model_task by @aaslan1997 in #553
• [Enhancement] Pass model_init_kwargs to sparse model auto tracing to load remote model class by @zhichao-aws in #555
• Update Pretrained Model Listing by @nathaliellenaa in #560
• Upgrade torch version to fix security issue by @nathaliellenaa in #561
• Upgade numpy and python version by @nathaliellenaa in #573
• Update space type value from cosine to cosinesimil by @nathaliellenaa in #574

New Contributors

• @aaslan1997 made their first contribution in #553

Full Changelog: 1.2.0...1.3.0

1.2.0

What's Changed

• Add description field with make_model_config_json function by @thanawan-atc in #203
• Correct demo_ml_commons_integration.ipynb by @thanawan-atc in #208
• Handle undefined model max length by @thanawan-atc in #219
• [Automating Model Tracing and Uploading] PR 1 Model Auto-tracing & Uploading by @thanawan-atc in #209
• Fixing typo in the model_search endpoint. by @dtaivpp in #227
• [Automating Model Tracing and Uploading] PR2 Model Listing & Uploading by @thanawan-atc in #210
• [Automating Model Tracing and Uploading] PR3 Modify ml-models-release Jenkins by @thanawan-atc in #211
• Bump torch from 1.13.1 to 2.0.1 (PR #161) + Add onnx dependency by @thanawan-atc in #237
• Update demo_tracing_model_torchscript_onnx.ipynb notebook by @thanawan-atc in #220
• Change to Use tokenCredentialId for Triggering ml-models-release via Generic Webhook by @thanawan-atc in #240
• Fix typo in model/model-listing workflow by @thanawan-atc in #244
• Fix typo in model listing workflow by @thanawan-atc in #246
• Update Pretrained Model Listing - 2023-08-23 16:51:21 by @github-actions in #248
• Add BUCKET_NAME to ml-models-release jenkinsfile by @thanawan-atc in #249
• Roll over pretrained_model_listing.json by @thanawan-atc in #252
• New file for new model listing format: pretrained_models_all_versions.json by @thanawan-atc in #256
• Force model tracing workflow to fail early for ≥2GB Model by @thanawan-atc in #258
• Rename model/model-listing workflows by @thanawan-atc in #260
• Update Pretrained Model Listing - 2023-08-30 14:07:38 by @github-actions in #264
• Fix pandas dependency issue in nox session by @thanawan-atc in #266
• Specify python version for doc and trace session by @thanawan-atc in #269
• Have model upload workflow require approval from two code maintainers by @thanawan-atc in #273
• Enable model listing workflow to exclude some models by @thanawan-atc in #265
• Update Pretrained Model Listing - 2023-09-08 13:14:07 by @github-actions in #277
• Update Model Upload History - sentence-transformers/msmarco-distilbert-base-tas-b (v.1.0.2)(BOTH) by @github-actions in #272
• Update Model Upload History - sentence-transformers/distiluse-base-multilingual-cased-v1 (v.1.0.1)(TORCH_SCRIPT) by @github-actions in #281
• Update Pretrained Model Listing - 2023-09-14 10:28:41 by @github-actions in #282
• Enable the model upload workflow to add model_content_size_in_bytes & model_content_hash_value to model config automatically by @thanawan-atc in #291
• Fix conditional job execution issue in model upload workflow by @thanawan-atc in #294
• Added example notebook for tracing and deploying CLIP model to opensearch by @patrickbarnhart in #283
• Update demo_deploy_cliptextmodel.ipynb by @patrickbarnhart in #302
• Fix issue with polling logic for registering models by @upwards-gravity in #301
• [OSCI] fixed formatting of install header in README.md by @VincentZhao12 in #305
• update ml_commons related cluster settings in developer guide by @rawwar in #311
• add doc model block by @xinyual in #319
• Update Model Upload History - sentence-transformers/paraphrase-mpnet-base-v2 (v.1.0.0)(BOTH) by @github-actions in #321
• Update Pretrained Model Listing - 2023-10-18 18:11:34 by @github-actions in #322
• limit pandas version to 1.X by @rawwar in #313
• reordering ml_commons tests : moved test_search to the end by @rawwar in #330
• ML-Commons train api functionality by @rawwar in #310
• Fix MLCommonClient_client.upload_model by @rawwar in #336
• #289 - Add register, update and delete model group functionality to support Model Access Control by @rawwar in #332
• replace is_datetime_or_timedelta_dtype by @rawwar in #316
• fix/datetime64 by @Prikshit7766 in #344
• Added deprecated module to setup.py Vinay Vinod [email protected] by @Vinay-Vinod in #337
• Add GitHub action for opensearch-py-ml release by @zelinh in #346
• add neural sparse doc model block to pretrained list by @xinyual in #348
• #284: Add support for connectors by @rawwar in #345
• updating tasb version 1.0.2 by @dhrubo-os in #357
• #285: Add support for Model profile by @rawwar in #358
• Update CI and docs to remove references to default admin creds by @derek-ho in #365
• #314: Update exception handling in mlcommons tests by using try-except-else block by @rawwar in #370
• Fixes lint failures on main by @rawwar in #374
• #339 : Remove separate pandas installations in nox tests by @rawwar in #368
• Switch AL2 to AL2023 agent and DockerHub to ECR images in ml-models.JenkinsFile by @peterzhuamazon in #377
• adding cross encoder models in list by @dhrubo-os in #378
• updating version number by @dhrubo-os in #379
• updating model version by @dhrubo-os in #380
• Fix CVE issues by pinning packages in requirements-dev.txt by @rawwar in #383
• fix: refactor validators in ml_commons client by @rawwar in #385
• Updating security reachout email by @varun-lodaya in #389
• Init a sparse model auto tracing workflow. by @conggguan in #394
• [Feature] Add a workflow parameter that model uploader can specific a folder prefix. by @conggguan in #398
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-doc-v2-distill (v.1.0.0)(TORCH_SCRIPT) by @github-actions in #400
• [Fix] Model uploader's jekins trigger parameter fix by @conggguan in #402
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-doc-v2-distill (v.1.0.0)(TORCH_SCRIPT) by @github-actions in #405
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-doc-v2-mini (v.1.0.0)(TORCH_SCRIPT) by @github-actions in #407
• Update Model Upload History - opensearch-project/opensearch-neural-sparse-encoding-v2-distill (v.1.0.0)(TORCH_SCRIPT) by @github-actions in #410
• updating listing file with three v2 sparse model by @dhrubo-os in #412
• [Fix] To change the model zip file name from hugging face org id to a c...

1.1.0

What's Changed

• Add release workflow for ml-models by @gaiksaya in #77
• updating docs by @dhrubo-os in #78
• listing pre-trained release models by @dhrubo-os in #85
• updating docs and linting issue by @dhrubo-os in #90
• Added untriaged issue workflow. by @dblock in #84
• updated documentation by @dhrubo-os in #98
• added a developer guide by @dhrubo-os in #101
• Update DEVELOPER_GUIDE.md by @Merey1508 in #113
• baselining codeowners and maintainers by @dhrubo-os in #120
• Upload pretrained models by @AlibiZhenis in #111
• Added delete task API. by @Nurlanprog in #127
• [CCI][FEATURE] Add test coverage statistics to Codecov by @Yerzhaisang in #138
• add greaa@ to maintainers by @greaa-aws in #150
• merging Feature/mcorr to main by @dhrubo-os in #141
• Adding boolean argument to ML Commons API by @AlibiZhenis in #143
• Allow ml-models/model_listing to publish without version by @prudhvigodithi in #158
• Allow ml-models/model_listing to publish without version by @prudhvigodithi in #160
• Updating ML Commons API documentation by @AlibiZhenis in #156
• Rename APIs for model serving framework by @AlibiZhenis in #159
• Bump mypy from 1.1.1 to 1.3.0 by @dependabot in #162
• Update pandas requirement from <2,>=1.5.2 to >=1.5.2,<3 by @dependabot in #133
• Bump sphinx-rtd-theme from 1.2.0 to 1.2.1 by @dependabot in #171
• Bump sphinx-rtd-theme from 1.2.1 to 1.2.2 by @dependabot in #174
• adding executeAPI by @AlibiZhenis in #165
• Edit code maintainers and codeowners by @b4sjoo in #178
• Files added by @miamia1999 in #166
• adding documentation for model group id by @dhrubo-os in #176
• Fix ModelUploader bug & Update demo_tracing_model_torchscript_onxx.ipnyb to use register function by @thanawan-atc in #185
• Fix make_model_config_json function by @thanawan-atc in #188
• Update jenkins file to use updated docker image by @gaiksaya in #189
• Make make_model_config_json function more concise by @thanawan-atc in #191
• Enabled auto-truncation for any pretrained models by @Yerzhaisang in #192
• Search task added by @Nurlanprog in #177
• MCorr example notebook by @AlibiZhenis in #186
• Generalize make_model_config_json function by @thanawan-atc in #200
• updating notebook + bumping version by @dhrubo-os in #199

New Contributors

• @Merey1508 made their first contribution in #113
• @AlibiZhenis made their first contribution in #111
• @Nurlanprog made their first contribution in #127
• @Yerzhaisang made their first contribution in #138
• @prudhvigodithi made their first contribution in #158
• @miamia1999 made their first contribution in #166
• @thanawan-atc made their first contribution in #185

Full Changelog: 1.0.0...1.1.0

v1.0.0

What's Changed

• Fixed bugs in Training Script
• Added multiple notebooks in documentation for better clarification
• Added integration tests and more functionalities for MLCommons integration
• Added support for tracing model in Onnx format
• updating installation instruction by @dhrubo-os in #41
• fix file extension issue and add wait for multi-processes by @mingshl in #42
• fixing train documentation by @dhrubo-os in #44
• removing os_client dependency + added 2.4.0 version for integration test by @dhrubo-os in #45
• add make_model_config function and add doc by @mingshl in #46
• upgrade package version to fix security issues and format code by @mingshl in #51
• Unit test for SentenceTransformerModel by @mingshl in #52
• refactoring upload_api + added integration test + added load model ap… by @dhrubo-os in #54
• bug fix of sentencetransformermodel + add integration test from mode… by @dhrubo-os in #63
• Updated MAINTAINERS.md format. by @dblock in #64
• notebook_documentation by @dhrubo-os in #66
• merged generate.py demo notebook with training notebook by @dhrubo-os in #67
• tracing model with onnx format + changed opesearch version to 2.5.0 by @dhrubo-os in #69
• updating docs workflow to 2.5.0 also by @dhrubo-os in #71
• Bump opensearch-py from 2.0.1 to 2.1.1 by @dependabot in #70
• added download link to the notebook by @dhrubo-os in #73
• update notebook + version update by @dhrubo-os in #76

New Contributors

• @dblock made their first contribution in #64
• @dependabot made their first contribution in #70

Full Changelog: 1.0.0b1...1.0.0

1.0.0b1

What's Changed

• Merging all the codes of dev to main branch. by @dhrubo-os in #9
• custom model upload + some documenation. by @dhrubo-os in #10
• adding template files to make repo public by @dhrubo-os in #12
• linting for windows and mac by @dhrubo-os in #14
• added documentation + fixed ipynb files by @dhrubo-os in #19
• fixing documentation issue by @dhrubo-os in #20
• changed naming + fixed ci workflow by @dhrubo-os in #21
• added documentation for ml_commons by @dhrubo-os in #23
• removing installation guide + adding more md files by @dhrubo-os in #26
• Add release workflows by @gaiksaya in #27
• add semantic search training script by @mingshl in #18
• updating version by @dhrubo-os in #33
• add demo notebook and return model by @mingshl in #34
• change version + documentation by @dhrubo-os in #36
• Increment jenkins lib version and fix GHA job name by @gaiksaya in #37
• change version to 1.0.0b1 by @ylwu-amzn in #38

New Contributors

• @dhrubo-os made their first contribution in #9
• @gaiksaya made their first contribution in #27
• @mingshl made their first contribution in #18
• @ylwu-amzn made their first contribution in #38

Full Changelog: https://github.com/opensearch-project/opensearch-py-ml/commits/1.0.0b1