Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.

docs: Get rid of Ranker docs #1197

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 0 additions & 46 deletions src/tags/control/Ranker.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,52 +30,6 @@ const RankerItemModel = types
},
}));

/**
* The `Ranker` tag is used to rank the results from models. This tag uses the "prediction" field from a labeling task instead of the "data" field to display content for labeling on the interface. Carefully structure your labeling tasks to work with this tag. See [import pre-annotated data](../guide/predictions.html).
*
* Use with the following data types: text.
*
* The Ranker tag renders a given list of strings and allows you to drag and reorder them.
* To see this tag in action:
* 1. Save the example JSON below as a file called <code>example_ranker_tag.json</code>.
* 2. Upload it as a task on the Label Studio UI.
* 3. Set up a project with the given labeling configuration.
*
* @example
* <!--Labeling configuration for ranking predicted text output from a model -->
* <View>
* <Text name="txt-1" value="$text"></Text>
* <Ranker name="ranker-1" toName="txt-1" ranked="true" sortedHighlightColor="red"></Ranker>
* </View>
* @example
* <!--Example JSON task to use to see the Ranker tag in action -->
* [{
* "data": {
* "text": "Some text for the ranker tag"
* },
* "predictions": [{
* "model_version": "1564027355",
* "result": [{
* "from_name": "ranker-1",
* "to_name": "ranker-1",
* "type": "ranker",
* "value": {
* "items": ["abc", "def", "ghk", "more more more", "really long text"],
* "weights": [1.00, 0.78, 0.75, 0.74, 0.74],
* "selected": [false, false, false, false, false]
* }
* }],
* "score": 1.0
* }]
* }]
* @name Ranker
* @meta_title Ranker Tag for Model Ranking
* @meta_description Customize Label Studio with the Ranker tag to rank the predictions from different models to rank model quality in your machine learning and data science projects.
* @param {string} name - Name of group
* @param {y|x} [axis=y] - Whether to use a vertical or horizantal axis direction for ranking
* @param {x|y} lockAxis - Lock axis
* @param {string} sortedHighlightColor - Sorted color in HTML color name
*/
const TagAttrs = types.model({
axis: types.optional(types.enumeration(['x', 'y']), 'y'),
lockaxis: types.maybeNull(types.enumeration(['x', 'y'])),
Expand Down