Commit Graph

64 Commits

Author SHA1 Message Date
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 a01ef06611
Add redirect for ML Dashboard (#4294)
Relates to issue https://github.com/opensearch-project/ml-commons-dashboards/issues/208

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-06-09 11:13:02 -05:00
astephanus 1fb5252cd6
Adds collections landing page configuration and navigation header linking (#3812)
* Adds collections landing page configuration and navigation header linking

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Removes unnecessary collection property from the configuration.

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds links to navigation collection headers to collection index pages based on the collection name

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Hide index pages from view and add info to formatting guide

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

---------

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-11 13:56:08 -04:00
Naarcha-AWS 72203306d4
Fix ML links (#3976)
* Fix ML links

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

* Fix style errors

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

* Fix RCF spelling

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

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-05-04 11:17:15 -05:00
kolchfa-aws 8463c8f278
Correct plugin capitalization (#3838)
* Correct plugin capitalization

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

* Revert cluster-stats because the name is in response

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

* Revert cluster-stats once more

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

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-04 11:11:54 -04:00
kolchfa-aws c9da6c07ad
Add style workflow (#3909)
* Tweak rules

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

* Rule changes

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

* Remove the following and simple

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

* Revised rules and added tests

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

* Soft rollout with only spelling and terms

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

* Add Vale to readme

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

* Only lint modified and added files

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

* Remove run on workflow dispatch

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

* Removed only added and modified files

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

* Added please

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

* Changed min alert level to warning

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

* Don't fail on error and minor changes

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

* Remove fail on error

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

* Attempt to have vale not fail

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

* Fixed links

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

* Update README.md

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

* Update README.md

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

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-05-03 12:34:05 -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
Naarcha-AWS b5d9cc598a
Add metrics correlation algorithm (#3877)
* Add metrics correlation algorithm

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

* Update algorithms.md

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

* Update algorithms.md

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

* Update algorithms.md

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

* Update _ml-commons-plugin/algorithms.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _ml-commons-plugin/algorithms.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _ml-commons-plugin/algorithms.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _ml-commons-plugin/algorithms.md

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
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>

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-04-27 12:33:25 -05:00
Naarcha-AWS 08a4128b5d
Add auto-truncation to pretrained models (#3756)
* Add auto-truncation to pretrained models

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

* Fix review feedback

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

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-04-13 11:21:54 -05:00
Naarcha-AWS fa643f9040
Add config parameters for traced models (#3456)
* Add config parameters for traced models

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

* Update model-serving-framework.md

* Update model-serving-framework.md

* Update model-serving-framework.md

* Update model-serving-framework.md

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-04-12 11:29:58 -05:00
Daniel (dB.) Doubrovkine 680c821937
Add CI with link checker. (#3584)
* Add CI with link checker.

Signed-off-by: dblock <dblock@amazon.com>

* Capture URI::InvalidURIError.

Signed-off-by: dblock <dblock@amazon.com>

* Use HEAD and catch URI errors.

Signed-off-by: dblock <dblock@amazon.com>

* Retry on a 405 with a GET.

Signed-off-by: dblock <dblock@amazon.com>

* Replaced external link checker with ruby-link-checker.

Signed-off-by: dblock <dblock@amazon.com>

* Don't exit with an exception.

Signed-off-by: dblock <dblock@amazon.com>

* Run internal link checker on build/ci.

Signed-off-by: dblock <dblock@amazon.com>

* Added broken links issue template.

Signed-off-by: dblock <dblock@amazon.com>

* Added host exclusions that 404 or fail on bots.

Signed-off-by: dblock <dblock@amazon.com>

* Raise anyway because Jekyll does it for us.

Signed-off-by: dblock <dblock@amazon.com>

* Fix broken links.

Signed-off-by: dblock <dblock@amazon.com>

* Only run link checker on main.

Signed-off-by: dblock <dblock@amazon.com>

* Re-add check-links.sh.

Signed-off-by: dblock <dblock@amazon.com>

* Run once a day on cron.

Signed-off-by: dblock <dblock@amazon.com>

---------

Signed-off-by: dblock <dblock@amazon.com>
2023-04-04 15:49:27 -04:00
Naarcha-AWS 32bc0d236e
Remove typo from ML cluster settings (#3529)
* Remove typo from ML cluster settings

* Update cluster-settings.md

Change default value
2023-03-20 16:00:50 -05:00
Naarcha-AWS b5e4dba463
Add newly approved pre-built models (#3444)
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-03-13 14:34:43 -05:00
Naarcha-AWS 4004030bca
Add Hugging Face link to ML documentation (#3134)
* Add Hugging Face link to ML documentation

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

* Fix links

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

* Fix a couple more links

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

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-03-03 10:22:53 -06:00
Naarcha-AWS ffac9d794a
Add 2.6 prebuilt models to Machine Learning (#2988)
* Add 2.6 prebuilt models

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

* Add supported prebuilt models

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

* Quick formatting tweak

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

* Add Jeff's feedback

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

* Add some light editorial feedback

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

* Update _ml-commons-plugin/pretrained-models.md

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

* Update _ml-commons-plugin/pretrained-models.md

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

* Update _ml-commons-plugin/pretrained-models.md

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

* Update _ml-commons-plugin/pretrained-models.md

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

* Add editorial feedback

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

* Add experimental label. Use same as model-serving framework

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

* Add example API call

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

* Add one last piece of feedback

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

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-02-28 13:02:30 -06:00
Naarcha-AWS 77da94dfed
Add ML Dashboards page (#2987)
* Add ML Dashboards page

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

* Add experimental ML Dashboard for 2.6

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

* Slight adjustment to picture order

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

* Add instructions to enable ML commons

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

* Small tweak

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

* Update _ml-commons-plugin/ml-dashboard.md

Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com>

* Add feedback

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

* Add additonal feedback

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

* Update _ml-commons-plugin/ml-dashboard.md

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

* Send fix through

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

* Add editorial feedback

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

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-02-27 13:14:24 -06: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 af824b3fb1
Add warning about regex experession in ML (#2536)
* Add warning about regex experession in ML

* Update cluster-settings.md

* Update cluster-settings.md

* Update _ml-commons-plugin/cluster-settings.md

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

* Update cluster-settings.md

---------

Co-authored-by: Yaliang Wu <ylwu@amazon.com>
2023-02-01 09:36:02 -06:00
Naarcha-AWS 985d31b8f7
Add additional ML cluster settings (#2487)
* Add additional ML cluster settings

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

* Update cluster-settings.md

* Fix other inaccuracies

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

* Update cluster-settings.md

* Update cluster-settings.md

* Update cluster-settings.md

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-01-25 11:54:25 -06:00
Naarcha-AWS 5bbeac2357
Fix links for 2.5 doc changes. (#2465)
* Fix links for 2.5 doc changes.

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

* Add CLI redirect

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2023-01-24 12:12:21 -06:00
Naarcha-AWS 1589201a9e
Add cluster awareness and decommission docs (#2438)
* Add cluster awareness and decommission docs

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

* Update _api-reference/cluster-awareness.md

Co-authored-by: Bukhtawar Khan <bukhtawar7152@gmail.com>

* Edit technical feedback

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

* Add new cluster awareness examples

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

* Add technical feedback

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

* Update _api-reference/cluster-awareness.md

Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>

* Update _api-reference/cluster-awareness.md

Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>

* Add Caroline's feedback

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

* Add one more tweak

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

* Update _ml-commons-plugin/cluster-settings.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _ml-commons-plugin/cluster-settings.md

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-decommission.md

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

* Update _api-reference/cluster-awareness.md

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

* Update _api-reference/cluster-decommission.md

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

* Add editoiral feedback

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

* Fix typos

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

* Final editorial note

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Bukhtawar Khan <bukhtawar7152@gmail.com>
Co-authored-by: Alice Williams <88908598+alicejw-aws@users.noreply.github.com>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Nate Bower <nbower@amazon.com>
2023-01-23 17:13:07 -06:00
Naarcha-AWS b2c87f7fa9
Add new ML cluster settings for 2.5 (#2442)
* Add new ML cluster settings for 2.5

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

* Update _ml-commons-plugin/cluster-settings.md

* Update model-serving-framework.md

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

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

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

* Update cluster-settings.md

* Update cluster-settings.md

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Yaliang Wu <ylwu@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2023-01-23 13:04:44 -06:00
Naarcha-AWS efa9f99e8d
Add GPU acceleration documentation (#2384)
* Add GPU acceleration documentation

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

* Address tech feedback

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

* Address technical feedback

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

* Adjust model size sentence

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

* Add optional to neuron step

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

* Add Jeff's feedback

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

* Add copy and customize for Inferntia examples

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

* Update _ml-commons-plugin/gpu-acceleration.md

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

* Update _ml-commons-plugin/gpu-acceleration.md

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

* Apply suggestions from code review

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

* Fix link

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

* Apply suggestions from code review

Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com>

* Update _ml-commons-plugin/gpu-acceleration.md

Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com>

* Update _ml-commons-plugin/gpu-acceleration.md

Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com>

* Update _ml-commons-plugin/gpu-acceleration.md

Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com>

* Fix numbering in final section

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

* Add final tech feedback

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

* A couple more suggestion

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

* Apply suggestions from code review

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

* Fix Neural Search link

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

* Add experimental warning

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

* Update _ml-commons-plugin/gpu-acceleration.md

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

* Final tech feedback

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

* Move OpenSearch to step 2.

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
Co-authored-by: Caroline <113052567+carolxob@users.noreply.github.com>
Co-authored-by: Yaliang Wu <ylwu@amazon.com>
2023-01-18 13:31:52 -06:00
Naarcha-AWS 320244db63
Fix Neural search pipeline example (#2177)
* Fix Neural search pipeline example

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

* Fix cluster settings

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-12-13 15:33:01 -06:00
Naarcha-AWS 429c0b256c
Fix Profile API table (#2066) 2022-11-29 12:32:31 -06:00
Naarcha-AWS 859e0b1830
Add ML commons settings (#2063)
* Add ML Commons Cluster Settings

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

* Add review feedback.

* Add Jeff's feedback

* Change all five-digit integers to programmatic format, add regular expression

* Update cluster-settings.md

* Change title back to original

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Fix merge conflict

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

* Change from table to header format

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

* Add ML commons cluster settings

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

* Update _ml-commons-plugin/cluster-settings.md

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

* Update cluster-settings.md

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Yaliang Wu <ylwu@amazon.com>
2022-11-28 16:17:52 -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 00dea2d06b
Add 2.4 content links to Version History (#1979)
* Add 2.4 content links to Version History

* Fix link URL

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

* Fix links. Fix experimental warnings

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

* Add security analytics

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-11-18 13:03:11 -06:00
Yaliang Wu 7770e127ce
tune model serving framework: add field details for model configs (#1976)
* tune model serving framework: add field details for model configs

Signed-off-by: Yaliang Wu <ylwu@amazon.com>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Signed-off-by: Yaliang Wu <ylwu@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2022-11-18 10:08:51 -06: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
kolchfa-aws 5f8d2fae09
Changes learning rate description (#1546)
* Fixes learning rate and momentum definitions

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

* Update algorithms.md

* Makes epsilon, beta1, beta2 and decayRate definitions uniform

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

* Changes learning rate description

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-10-12 16:46:34 -04:00
kolchfa-aws 2da7b3ab43
Fixes learning rate and momentum definitions (#1498)
* Fixes learning rate and momentum definitions

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

* Update algorithms.md

* Makes epsilon, beta1, beta2 and decayRate definitions uniform

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-10-11 20:01:36 -04:00
Naarcha-AWS c69f860bfe
Add PPL and SQL section (#1111)
* Merge pull request #1 from Yury-Fridlyand/dev-update-sql-relevance-docs

Update SQL plugin relevance functions documentation.

Co-authored-by: MaxKsyunz <maxk@bitquilltech.com>
Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>

* Address PR feedback.

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>

* Address PR feedback by @joshuali925.

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>

* Remove PPL page from Observability Plugin. Add link to Observability page. Make some simple formatting changes

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

* Reword paragraph

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

* Adds SQL and PPL API and other SQL plugin changes

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

* Formatting changes

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

* Incorporates editorial comments

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

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Yury Fridlyand <yuryf@bitquilltech.com>
Co-authored-by: MaxKsyunz <maxk@bitquilltech.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
2022-09-26 12:28:00 -04:00
Naarcha-AWS 201e3fcb46
Add Logistic and RCF algorthims (#864)
* Add Logistic and RCF algorthims

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

* Add RCF Summarize and copyedits

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

* Add feedback. Add new parameter descriptions

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

* Fix typo

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

* Fix typo

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

* Change style of k-means

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

* Add editorial feedback

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

* Resolve one last typo

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

* Add final editorial feedback

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-08-11 16:05:59 -04:00
Naarcha-AWS 6336b83b14
Add ML node settings and dynamic node description (#787)
* Add ML node instructions

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

* Change cluster settings from ml to dynamic

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

* Quick typo fix

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

* Adjust ML docs to remove dymanic mention. Adjust CAT example to be general

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

* Add editorial feedback.

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

* Fix columns in example

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-07-21 15:57:45 -05: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
Naarcha-AWS 8042de2098 Add ML commons algorthim documentation
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-23 11:29:54 -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 35bfcd883d
Merge pull request #512 from opensearch-project/remove-mapping-types2.0
Remove type from all API requests and responses
2022-05-03 14:33:31 -05: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
keithhc2 b1b32bda67 Fixed broken link
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-04-07 17:02:18 -07:00
Naarcha-AWS c063580eb6 Fix links in ML commons index
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-03-23 08:46:40 -05:00