Commit Graph

32 Commits

Author SHA1 Message Date
kolchfa-aws f5b8ff79fd
Add score normalization and combination documentation (#4985)
* Add search phase results processor

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add hybrid query

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Normalization processor additions

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add more details

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Continue writing

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add more query then fetch details and diagram

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Small rewording

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Leaner left nav headers

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Tech review feedback

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add semantic search tutorial

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Reworded prerequisites

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Removed comma

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Rewording advanced prerequisites

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Changed searching for ML model to shorter request

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update task type in register model response

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Changing example

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added huggingface prefix to model names

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Change example responses

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added note about huggingface prefix

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

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

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Implemented doc review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* List weights under parameters

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove one-shard warning for normalization processor

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Change links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* More editorial feedback

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Change model-serving framework to ML framework

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Use get model API to check model status

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added neural search description and diagram

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* More editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add link to profile API

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Addressed more tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented editorial comments on changes

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-09-22 17:29:58 -04:00
kolchfa-aws 06665364fd
Update model access control documentation (#4552)
* Update model access control documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove duplicated info

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Reword registering model

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Reword registering model

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Clarification for model size

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _ml-commons-plugin/api.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

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

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _ml-commons-plugin/api.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Add tech review comment

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _ml-commons-plugin/api.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Reworded for clarity

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-18 10:55:58 -04:00
kolchfa-aws 52b4a9ee9f
Add model access control documentation for ML Commons (#4223)
* Add model access control documentation for ML Commons

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove permissions for delete API

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add copy buttons

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Updated model-level APIs

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add delete model

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Reworded role-related text

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Rewording

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove experimental warning

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Register a model group in note format

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implement tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Resolved Vale comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Remove space

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Implemented doc review feedback

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Add more editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add more editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix more links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
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 <97990722+Naarcha-AWS@users.noreply.github.com>

* Fix links

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix links

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add line to make build go again

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

---------

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-05-02 08:50:27 -05:00
Naarcha-AWS bce2e33444
Add ML fault tolerance (#3803)
* Add ML fault tolerance

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Rework Profile API sentence

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix link

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add review feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add technical feedback for ML. Change API names

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add final ML node setting

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add more technical feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Apply suggestions from code review

Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update cluster-settings.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _ml-commons-plugin/api.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _ml-commons-plugin/api.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _ml-commons-plugin/api.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _ml-commons-plugin/api.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _ml-commons-plugin/api.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update api.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-01 08:16:21 -05:00
kolchfa-aws 3da7598c0c
Change sample to example (#2972)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-02-20 11:34:20 -05:00
Naarcha-AWS 158a4fd5c1
Fix ML commons typo (#2726)
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
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 <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-11-18 15:25:06 -05:00
Naarcha-AWS f055d7d2d0
Editorial review for Model Framework and Neural Search (#1956)
* Fix header in ML commons

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Remove redundant file

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

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

Co-authored-by: Yaliang Wu <ylwu@amazon.com>

* Add lines for easier editing

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Update _ml-commons-plugin/api.md

Co-authored-by: Nate Bower <nbower@amazon.com>

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

Co-authored-by: Nate Bower <nbower@amazon.com>

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

Co-authored-by: Nate Bower <nbower@amazon.com>

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

Co-authored-by: Nate Bower <nbower@amazon.com>

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

Co-authored-by: Nate Bower <nbower@amazon.com>

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

Co-authored-by: Nate Bower <nbower@amazon.com>

* Add ML editorial feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

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

Co-authored-by: Nate Bower <nbower@amazon.com>

* Add Neural Search section (#1882)

* Add Neural Search section

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add getting started instructions

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add example responses to Neural Search

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add neural request fields

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add review tweaks

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add forum link

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Update _neural-search-plugin/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update index.md

* Fix second sentence

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* 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 <armarble@amazon.com>

* made editorial changes

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>

* Add ML commons plugin

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Change model serving format

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix plugin cap

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Neural Search editorial

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Update index.md

Incorporate Chris' feedback

* Update model-serving-framework.md

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: Yaliang Wu <ylwu@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Aria Marble <111301581+ariamarble@users.noreply.github.com>
2022-11-17 13:42:24 -06:00
Naarcha-AWS 499cdb938c
Add model serving framework instructions (#1880)
* Add model serving framework instructions

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Change title to match file name

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

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

Co-authored-by: Yaliang Wu <ylwu@amazon.com>

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

Co-authored-by: Yaliang Wu <ylwu@amazon.com>

* 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 <naarcha@amazon.com>

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

* Add more review feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add profile API

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add note about model limitations

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Another round of feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add final bits of Yalings feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Yaliang Wu <ylwu@amazon.com>
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 <naarcha@amazon.com>

* Remove Anomaly

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add editorial review

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Final feedback

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Make sure note renders properly

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix capitalization

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