Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit 21b1e07

Browse files
Clarify fastText Model Type (#1077)
* Clarify Fasttext Model Type The classification and nearest_neighbors analyzers only accept supervised models. * added EE note * formatting typo Co-authored-by: ansoboleva <93702078+ansoboleva@users.noreply.github.com>
1 parent 0ce8036 commit 21b1e07

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

3.10/analyzers.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -980,6 +980,8 @@ Create different `segmentation` Analyzers to show the behavior of the different
980980
981981
<small>Introduced in: v3.10.0</small>
982982
983+
{% include hint-ee.md feature="The `classification` analyzer" %}
984+
983985
{% hint 'warning' %}
984986
This feature is experimental and under active development.
985987
The naming and interfaces may change at any time.
@@ -988,13 +990,13 @@ Execution times are not representative of the final product.
988990
989991
An Analyzer capable of classifying tokens in the input text.
990992
991-
It applies a user-provided [fastText](https://fasttext.cc/){:target="_blank"}
993+
It applies a user-provided [supervised fastText](https://fasttext.cc/docs/en/supervised-tutorial.html){:target="_blank"}
992994
word embedding model to classify the input text. It is able to classify
993995
individual tokens as well as entire inputs.
994996
995997
The *properties* allowed for this Analyzer are an object with the following attributes:
996998
997-
- `model_location` (string): the on-disk path to the trained fastText model.
999+
- `model_location` (string): the on-disk path to the trained fastText supervised model.
9981000
Note: if you are running this in an ArangoDB cluster, this model must exist on
9991001
every machine in the cluster.
10001002
- `top_k` (number, optional): the number of class labels that will be produced
@@ -1038,6 +1040,8 @@ db._query(`LET str = "Which baking dish is best to bake a banana bread ?"
10381040

10391041
<small>Introduced in: v3.10.0</small>
10401042

1043+
{% include hint-ee.md feature="The `nearest_neighbors` analyzer" %}
1044+
10411045
{% hint 'warning' %}
10421046
This feature is experimental and under active development.
10431047
The naming and interfaces may change at any time.
@@ -1046,15 +1050,15 @@ Execution times are not representative of the final product.
10461050

10471051
An Analyzer capable of finding nearest neighbors of tokens in the input.
10481052

1049-
It applies a user-provided [fastText](https://fasttext.cc/){:target="_blank"}
1053+
It applies a user-provided [supervised fastText](https://fasttext.cc/docs/en/supervised-tutorial.html){:target="_blank"}
10501054
word embedding model to retrieve nearest neighbor tokens in the text.
10511055
It is able to find neighbors of individual tokens as well as entire input strings.
10521056
For entire input strings, the Analyzer will return nearest neighbors for each
10531057
token within the input string.
10541058

10551059
The *properties* allowed for this Analyzer are an object with the following attributes:
10561060

1057-
- `model_location` (string): the on-disk path to the trained fastText model.
1061+
- `model_location` (string): the on-disk path to the trained fastText supervised model.
10581062
Note: if you are running this in an ArangoDB cluster, this model must exist on
10591063
every machine in the cluster.
10601064
- `top_k` (number, optional): the number of class labels that will be produced

0 commit comments

Comments
 (0)