Spaces:
Runtime error
Runtime error
File size: 2,650 Bytes
1c60c6e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# Copyright 2021-present, the Recognai S.L. team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import Optional
from argilla.client import api
from argilla.metrics import helpers
from argilla.metrics.models import MetricSummary
def text_length(name: str, query: Optional[str] = None) -> MetricSummary:
"""Computes the input text length metrics for a dataset
Args:
name:
The dataset name.
query:
An ElasticSearch query with the [query string syntax](https://argilla.readthedocs.io/en/stable/guides/queries.html)
Returns:
The text length metric summary
Examples:
>>> from argilla.metrics.commons import text_length
>>> summary = text_length(name="example-dataset")
>>> summary.visualize() # will plot an histogram with results
>>> summary.data # returns the raw result data
"""
metric = api.active_api().compute_metric(name, metric="text_length", query=query)
return MetricSummary.new_summary(
data=metric.results,
visualization=lambda: helpers.histogram(
data=metric.results, title=metric.description
),
)
def records_status(name: str, query: Optional[str] = None) -> MetricSummary:
"""Computes the records status distribution for a dataset
Args:
name:
The dataset name.
query:
An ElasticSearch query with the [query string syntax](https://argilla.readthedocs.io/en/stable/guides/queries.html)
Returns:
The status distribution metric summary
Examples:
>>> from argilla.metrics.commons import records_status
>>> summary = records_status(name="example-dataset")
>>> summary.visualize() # will plot an histogram with results
>>> summary.data # returns the raw result data
"""
metric = api.active_api().compute_metric(
name, metric="status_distribution", query=query
)
return MetricSummary.new_summary(
data=metric.results,
visualization=lambda: helpers.bar(
data=metric.results, title=metric.description
),
)
|