Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ML] Add prefix strings option to trained models #102089

Merged
merged 10 commits into from
Nov 14, 2023

Conversation

davidkyle
Copy link
Member

Raised in place of #101978

Certain NLP models such as multilingual-e5-large require a prefix string to be applied to the input text. For asymmetric tasks such as information retrieval the prefix can be different when ingesting the data and when searching it. For example text embedding model can have a one prefix applied when the model is evaluated as part of an knn search and a different prefix when ingesting documents.

An example model configuration with prefix strings is:

{
    "model_type": "pytorch",
    "inference_config": {
        "text_embedding": {
            "tokenization": {
                "xlm_roberta": {
                    "do_lower_case": false,
                    "with_special_tokens": true,
                    "max_sequence_length": 512,
                    "truncate": "first",
                    "span": -1
                }
            },
            "embedding_size": 384
        }
    },
    "prefix_strings": {
        "search": "this is a query",
        "ingest": "this is a passage"
    }
}

Many files have been touched by this change but the bulk of the work is quite simple: define the configuration object an pass the prefix type (context) parameter down the inference calls.

davidkyle and others added 7 commits November 13, 2023 14:44
Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
# Conflicts:
#	x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ml/inference/TrainedModelConfig.java
@davidkyle davidkyle added >enhancement :ml Machine learning cloud-deploy Publish cloud docker image for Cloud-First-Testing v8.12.0 labels Nov 13, 2023
Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added the Team:ML Meta label for the ML team label Nov 13, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

@elasticsearchmachine
Copy link
Collaborator

Hi @davidkyle, I've created a changelog YAML for you.

Copy link
Contributor

@droberts195 droberts195 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 2

@davidkyle
Copy link
Member Author

@elasticmachine update branch

@davidkyle davidkyle merged commit 330e8b9 into elastic:main Nov 14, 2023
15 checks passed
davidkyle added a commit to elastic/elasticsearch-specification that referenced this pull request Jan 2, 2024
The prefix_strings option was added to support the E5 model in
elastic/elasticsearch#102089
davidkyle added a commit to elastic/elasticsearch-specification that referenced this pull request Mar 13, 2024
The prefix_strings option was added to support the E5 model in
elastic/elasticsearch#102089
pquentin pushed a commit to elastic/elasticsearch-specification that referenced this pull request Mar 14, 2024
* Add prefix_string config option for ML models (#2363)

The prefix_strings option was added to support the E5 model in
elastic/elasticsearch#102089

* Add prefix_strings option to PUT model request (#2449)

Follow up to #2363 where prefix_strings option was added to TrainedModelConfig
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cloud-deploy Publish cloud docker image for Cloud-First-Testing >enhancement :ml Machine learning Team:ML Meta label for the ML team v8.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants