Commit Graph
33 Commits
Author SHA1 Message Date
a97c719591 Add multimodal search/sparse search/pre- and post-processing function documentation (#5168)
* Add multimodal search documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Text image embedding processor

Signed-off-by: Fanit Kolchina <[email protected]>

* Add prerequisite

Signed-off-by: Fanit Kolchina <[email protected]>

* Change query text

Signed-off-by: Fanit Kolchina <[email protected]>

* Added bedrock connector tutorial and renamed ML TOC

Signed-off-by: Fanit Kolchina <[email protected]>

* Name changes and rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Change connector link

Signed-off-by: Fanit Kolchina <[email protected]>

* Change link

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Link fix and field name fix

Signed-off-by: Fanit Kolchina <[email protected]>

* Add default text embedding preprocessing and post-processing functions

Signed-off-by: Fanit Kolchina <[email protected]>

* Add sparse search documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Fix links

Signed-off-by: Fanit Kolchina <[email protected]>

* Pre/post processing function tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Fix link

Signed-off-by: Fanit Kolchina <[email protected]>

* Sparse search tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Add actual test sparse pipeline response

Signed-off-by: Fanit Kolchina <[email protected]>

* Added tested examples

Signed-off-by: Fanit Kolchina <[email protected]>

* Added model choice for sparse search

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove Bedrock connector

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented tech review feedback

Signed-off-by: Fanit Kolchina <[email protected]>

* Add that the model must be deployed to neural search

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Link fix

Signed-off-by: Fanit Kolchina <[email protected]>

* Add session token to sagemaker blueprint

Signed-off-by: Fanit Kolchina <[email protected]>

* Formatted bullet points the same way

Signed-off-by: Fanit Kolchina <[email protected]>

* Specified both model types in neural sparse query

Signed-off-by: Fanit Kolchina <[email protected]>

* Added more explanation for default pre/post-processing functions

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove framework and extensibility references

Signed-off-by: Fanit Kolchina <[email protected]>

* Minor rewording

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-10-16 10:45:35 -04:00
f5b8ff79fd Add score normalization and combination documentation (#4985)
* Add search phase results processor

Signed-off-by: Fanit Kolchina <[email protected]>

* Add hybrid query

Signed-off-by: Fanit Kolchina <[email protected]>

* Normalization processor additions

Signed-off-by: Fanit Kolchina <[email protected]>

* Add more details

Signed-off-by: Fanit Kolchina <[email protected]>

* Continue writing

Signed-off-by: Fanit Kolchina <[email protected]>

* Add more query then fetch details and diagram

Signed-off-by: Fanit Kolchina <[email protected]>

* Small rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Leaner left nav headers

Signed-off-by: Fanit Kolchina <[email protected]>

* Tech review feedback

Signed-off-by: Fanit Kolchina <[email protected]>

* Add semantic search tutorial

Signed-off-by: Fanit Kolchina <[email protected]>

* Reworded prerequisites

Signed-off-by: Fanit Kolchina <[email protected]>

* Removed comma

Signed-off-by: Fanit Kolchina <[email protected]>

* Rewording advanced prerequisites

Signed-off-by: Fanit Kolchina <[email protected]>

* Changed searching for ML model to shorter request

Signed-off-by: Fanit Kolchina <[email protected]>

* Update task type in register model response

Signed-off-by: Fanit Kolchina <[email protected]>

* Changing example

Signed-off-by: Fanit Kolchina <[email protected]>

* Added huggingface prefix to model names

Signed-off-by: Fanit Kolchina <[email protected]>

* Change example responses

Signed-off-by: Fanit Kolchina <[email protected]>

* Added note about huggingface prefix

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _ml-commons-plugin/semantic-search.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* List weights under parameters

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove one-shard warning for normalization processor

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Change links

Signed-off-by: Fanit Kolchina <[email protected]>

* More editorial feedback

Signed-off-by: Fanit Kolchina <[email protected]>

* Change model-serving framework to ML framework

Signed-off-by: Fanit Kolchina <[email protected]>

* Use get model API to check model status

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Added neural search description and diagram

Signed-off-by: Fanit Kolchina <[email protected]>

* More editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Add link to profile API

Signed-off-by: Fanit Kolchina <[email protected]>

* Addressed more tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented editorial comments on changes

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-09-22 17:29:58 -04:00
06665364fd Update model access control documentation (#4552)
* Update model access control documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove duplicated info

Signed-off-by: Fanit Kolchina <[email protected]>

* Add tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Add tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Reword registering model

Signed-off-by: Fanit Kolchina <[email protected]>

* Reword registering model

Signed-off-by: Fanit Kolchina <[email protected]>

* Clarification for model size

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _ml-commons-plugin/api.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _ml-commons-plugin/model-access-control.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update _ml-commons-plugin/api.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Add tech review comment

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _ml-commons-plugin/api.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Reworded for clarity

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-07-18 10:55:58 -04:00
52b4a9ee9f Add model access control documentation for ML Commons (#4223)
* Add model access control documentation for ML Commons

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove permissions for delete API

Signed-off-by: Fanit Kolchina <[email protected]>

* Add copy buttons

Signed-off-by: Fanit Kolchina <[email protected]>

* Updated model-level APIs

Signed-off-by: Fanit Kolchina <[email protected]>

* Add delete model

Signed-off-by: Fanit Kolchina <[email protected]>

* Reworded role-related text

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove experimental warning

Signed-off-by: Fanit Kolchina <[email protected]>

* Register a model group in note format

Signed-off-by: Fanit Kolchina <[email protected]>

* Implement tech review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Resolved Vale comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove space

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented doc review feedback

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Add more editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Add more editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Fix links

Signed-off-by: Fanit Kolchina <[email protected]>

* Fix more links

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
2023-06-19 15:25:13 -04:00
Naarcha-AWS aa6483903c Fix spelling error on upgrade page (#3910)
* Fix spelling error on upgrade page

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix links

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix links

Signed-off-by: Naarcha-AWS <[email protected]>

* Add line to make build go again

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
2023-05-02 08:50:27 -05:00
bce2e33444 Add ML fault tolerance (#3803)
* Add ML fault tolerance

Signed-off-by: Naarcha-AWS <[email protected]>

* Rework Profile API sentence

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix link

Signed-off-by: Naarcha-AWS <[email protected]>

* Add review feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Add technical feedback for ML. Change API names

Signed-off-by: Naarcha-AWS <[email protected]>

* Add final ML node setting

Signed-off-by: Naarcha-AWS <[email protected]>

* Add more technical feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update cluster-settings.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/api.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/api.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/api.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/api.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/api.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update api.md

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-05-01 08:16:21 -05:00
kolchfa-aws 3da7598c0c Change sample to example (#2972)
Signed-off-by: Fanit Kolchina <[email protected]>
2023-02-20 11:34:20 -05:00
Naarcha-AWS 158a4fd5c1 Fix ML commons typo (#2726)
Signed-off-by: Naarcha-AWS <[email protected]>
2023-02-08 17:43:42 -06:00
Naarcha-AWS 429c0b256c Fix Profile API table (#2066) 2022-11-29 12:32:31 -06:00
kolchfa-aws 63019c421d Puts column headers in sentence case (#1989)
Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
2022-11-18 15:25:06 -05:00
f055d7d2d0 Editorial review for Model Framework and Neural Search (#1956)
* Fix header in ML commons

Signed-off-by: Naarcha-AWS <[email protected]>

* Remove redundant file

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Yaliang Wu <[email protected]>

* Add lines for easier editing

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/api.md

Co-authored-by: Nate Bower <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Nate Bower <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Nate Bower <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Nate Bower <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Nate Bower <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Nate Bower <[email protected]>

* Add ML editorial feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Nate Bower <[email protected]>

* Add Neural Search section (#1882)

* Add Neural Search section

Signed-off-by: Naarcha-AWS <[email protected]>

* Add getting started instructions

Signed-off-by: Naarcha-AWS <[email protected]>

* Add example responses to Neural Search

Signed-off-by: Naarcha-AWS <[email protected]>

* Add neural request fields

Signed-off-by: Naarcha-AWS <[email protected]>

* Add review tweaks

Signed-off-by: Naarcha-AWS <[email protected]>

* Add forum link

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _neural-search-plugin/index.md

Co-authored-by: kolchfa-aws <[email protected]>

* Update index.md

* Fix second sentence

Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>

* Small typos in Neural Search (#1959)

* Small typos in Neural Search

* Update index.md

* Update index.md

* Update plugin documentation to reference the CAT API (#1962)

* Update plugin documentation to reference the CAT API

Signed-off-by: ariamarble <[email protected]>

* made editorial changes

Signed-off-by: ariamarble <[email protected]>

Signed-off-by: ariamarble <[email protected]>

* Add ML commons plugin

Signed-off-by: Naarcha-AWS <[email protected]>

* Change model serving format

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix plugin cap

Signed-off-by: Naarcha-AWS <[email protected]>

* Neural Search editorial

Signed-off-by: Naarcha-AWS <[email protected]>

* Update index.md

Incorporate Chris' feedback

* Update model-serving-framework.md

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: ariamarble <[email protected]>
Co-authored-by: Yaliang Wu <[email protected]>
Co-authored-by: Nate Bower <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
2022-11-17 13:42:24 -06:00
Naarcha-AWSandYaliang Wu 499cdb938c Add model serving framework instructions (#1880)
* Add model serving framework instructions

Signed-off-by: Naarcha-AWS <[email protected]>

* Change title to match file name

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Yaliang Wu <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

Co-authored-by: Yaliang Wu <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

* Update _ml-commons-plugin/model-serving-framework.md

* Update _ml-commons-plugin/model-serving-framework.md

* Update _ml-commons-plugin/model-serving-framework.md

* Update _ml-commons-plugin/model-serving-framework.md

* Update _ml-commons-plugin/model-serving-framework.md

* Update _ml-commons-plugin/model-serving-framework.md

* Add developer feedback. Fix typos

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _ml-commons-plugin/model-serving-framework.md

* Add more review feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Add profile API

Signed-off-by: Naarcha-AWS <[email protected]>

* Add note about model limitations

Signed-off-by: Naarcha-AWS <[email protected]>

* Another round of feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Add final bits of Yalings feedback

Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Yaliang Wu <[email protected]>
2022-11-16 18:28:48 -08:00
Naarcha-AWS 16b3099e2f Add Execute Command to API documentation. (#711)
* Add Execute Command to API documentation.

Signed-off-by: Naarcha-AWS <[email protected]>

* Remove Anomaly

Signed-off-by: Naarcha-AWS <[email protected]>

* Add editorial review

Signed-off-by: Naarcha-AWS <[email protected]>

* Final feedback

Signed-off-by: Naarcha-AWS <[email protected]>

* Make sure note renders properly

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix capitalization

Signed-off-by: Naarcha-AWS <[email protected]>
2022-07-06 11:16:03 -05:00
Naarcha-AWS ffa9c14031 Final bits of feedback
Signed-off-by: Naarcha-AWS <[email protected]>
2022-05-26 13:35:56 -05:00
Naarcha-AWS adbf630735 Add review feedback
Signed-off-by: Naarcha-AWS <[email protected]>
2022-05-26 10:31:29 -05:00
Naarcha-AWS fb1a0181e9 Add review feedback
Signed-off-by: Naarcha-AWS <[email protected]>
2022-05-24 09:41:26 -05:00
hdhalter 099ba00c71 Merge pull request #581 from opensearch-project/Fix#560
Fixed issue #560
2022-05-18 16:12:30 -07:00
Heather Halter 417b2446fe “fix
git commit -s -m “fix

Signed-off-by: Heather Halter <[email protected]>
2022-05-18 14:26:40 -07:00
Heather Halter 8111e18344 “fixed
Signed-off-by: Heather Halter <[email protected]>
2022-05-17 18:36:38 -07:00
Naarcha-AWS 0a24fa2992 Remove from all API requests and responses
Signed-off-by: Naarcha-AWS <[email protected]>
2022-04-14 12:55:17 -05:00
Naarcha-AWS 0417e971b8 Add more consistency to headers
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-22 12:52:10 -05:00
Naarcha-AWS a637997543 Add additional context to intro
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-22 10:13:32 -05:00
Naarcha-AWS 07e7fc4478 Regroup APIs
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-21 18:59:35 -05:00
Naarcha-AWS 8bcad52409 Final changes
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-21 18:52:03 -05:00
Naarcha-AWS 421a6444fb A couple more language tweaks
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-21 16:22:48 -05:00
Naarcha-AWS d039da1b18 Reword API inputs
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-21 15:28:37 -05:00
Naarcha-AWS bbbcdc32ef Incorporate final technical feedback
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-21 15:20:31 -05:00
Naarcha-AWS 7b01859ee9 Add review feedback
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-19 12:37:01 -05:00
Naarcha-AWS ebbab2dea0 Fix link in Index.md
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-18 12:33:10 -05:00
Naarcha-AWS aa7356a787 Add links to API and PPl. Add to site.
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-18 11:45:21 -05:00
Naarcha-AWS 7dd37280ae Add all ML commons API endpoints and responses
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-18 11:25:19 -05:00
Naarcha-AWS 3b79db7383 Add API endpoints
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-17 17:18:15 -05:00
Naarcha-AWS f78b5f612d Add ML commons Plugin section
Signed-off-by: Naarcha-AWS <[email protected]>
2022-03-17 12:02:29 -05:00