Commit Graph

22 Commits

Author SHA1 Message Date
kolchfa-aws f999e0a8a8
Add an overview of search methods and pages for each search method (#5636)
* Restructuring TOC

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

* Resolve merge conflicts

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

* More foundational rewrites of ML

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

* TOC restructure

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

* Rename and rewrite search pages and add keyword search

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

* Small wording change

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

* Small wording change

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

* Updated response

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>

* Small rewording

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

* Move neural search to top of vector search list

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

* Change terminology

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

* Reorganize search methods list

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

* Rename links

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

* More link renames

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>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-11-29 15:28:20 -05:00
kolchfa-aws 826e6771ed
Refactor ML section - local and remote models (#5609)
* Refactor ML section - local and remote models

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

* Added command to calculate checksum

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

* Add ONNX format to register API

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

* Add sparse encoding predict example

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

* Add API section

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

* Refactor the API section

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

* Typo

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

* Implemented Vale comments

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

* Add get connector API

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

* Reword heading

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

* Addressed tech review 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>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
2023-11-17 15:59:27 -05:00
kolchfa-aws a97c719591
Add multimodal search/sparse search/pre- and post-processing function documentation (#5168)
* Add multimodal search documentation

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

* Text image embedding processor

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

* Add prerequisite

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

* Change query text

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

* Added bedrock connector tutorial and renamed ML TOC

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

* Name changes and rewording

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

* Change connector link

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

* Change link

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

* Implemented tech review comments

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

* Link fix and field name fix

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

* Add default text embedding preprocessing and post-processing functions

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

* Add sparse search documentation

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

* Fix links

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

* Pre/post processing function tech review comments

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

* Fix link

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

* Sparse search tech review 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>

* Implemented doc review comments

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

* Add actual test sparse pipeline response

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

* Added tested examples

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

* Added model choice for sparse search

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

* Remove Bedrock connector

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

* Implemented tech review feedback

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

* Add that the model must be deployed to neural search

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>

* Link fix

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

* Add session token to sagemaker blueprint

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

* Formatted bullet points the same way

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

* Specified both model types in neural sparse query

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

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

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

* Remove framework and extensibility references

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

* Minor rewording

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: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-10-16 10:45:35 -04:00
David Tippett 2eb81a3e19
Ml commons (#5017)
* Adding ML Node to cluster settings page

Signed-off-by: David Tippett <17506770+dtaivpp@users.noreply.github.com>

* Removed Permissions and Cluster Settings from index; added roles to model access control

Signed-off-by: David Tippett <17506770+dtaivpp@users.noreply.github.com>

* Referenced code sample was for local connector not external

Signed-off-by: David Tippett <17506770+dtaivpp@users.noreply.github.com>

* Updated ML index page to refrence the order to get started with ML Commons.

Signed-off-by: David Tippett <17506770+dtaivpp@users.noreply.github.com>

* Fixing style errors.

Signed-off-by: David Tippett <17506770+dtaivpp@users.noreply.github.com>

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

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>

* Update _ml-commons-plugin/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>

* Update _ml-commons-plugin/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>

* Update _ml-commons-plugin/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>

* Update _ml-commons-plugin/index.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>

* Update _ml-commons-plugin/extensibility/connectors.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>

* Update _ml-commons-plugin/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>

* Update _ml-commons-plugin/index.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>

---------

Signed-off-by: David Tippett <17506770+dtaivpp@users.noreply.github.com>
Signed-off-by: David Tippett <Dtaivpp@gmail.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-09-21 14:44:19 -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
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 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 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 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
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
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 bbbcdc32ef Incorporate final technical feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-03-21 15:20:31 -05:00
Naarcha-AWS 228dd73a60 Small fix
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-03-21 10:13:15 -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 f78b5f612d Add ML commons Plugin section
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-03-17 12:02:29 -05:00