Spaces:
Sleeping
Sleeping
File size: 6,853 Bytes
836eb10 |
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 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
"""gr.Timeseries() component."""
from __future__ import annotations
from pathlib import Path
from typing import Any, Callable, Literal
import pandas as pd
from gradio_client.documentation import document, set_documentation_group
from gradio_client.serializing import JSONSerializable
from gradio.components.base import IOComponent, _Keywords
from gradio.events import Changeable
set_documentation_group("component")
@document()
class Timeseries(Changeable, IOComponent, JSONSerializable):
"""
Creates a component that can be used to upload/preview timeseries csv files or display a dataframe consisting of a time series graphically.
Preprocessing: passes the uploaded timeseries data as a {pandas.DataFrame} into the function
Postprocessing: expects a {pandas.DataFrame} or {str} path to a csv to be returned, which is then displayed as a timeseries graph
Examples-format: a {str} filepath of csv data with time series data.
Demos: fraud_detector
"""
def __init__(
self,
value: str | Callable | None = None,
*,
x: str | None = None,
y: str | list[str] | None = None,
colors: list[str] | None = None,
label: str | None = None,
every: float | None = None,
show_label: bool | None = None,
container: bool = True,
scale: int | None = None,
min_width: int = 160,
interactive: bool | None = None,
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
**kwargs,
):
"""
Parameters:
value: File path for the timeseries csv file. If callable, the function will be called whenever the app loads to set the initial value of the component.
x: Column name of x (time) series. None if csv has no headers, in which case first column is x series.
y: Column name of y series, or list of column names if multiple series. None if csv has no headers, in which case every column after first is a y series.
label: component name in interface.
every: If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
colors: an ordered list of colors to use for each line plot
show_label: if True, will display label.
container: If True, will place the component in a container - providing some extra padding around the border.
scale: relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.
min_width: minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
interactive: if True, will allow users to upload a timeseries csv; if False, can only be used to display timeseries data. If not provided, this is inferred based on whether the component is used as an input or output.
visible: If False, component will be hidden.
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes: An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
"""
self.x = x
if isinstance(y, str):
y = [y]
self.y = y
self.colors = colors
IOComponent.__init__(
self,
label=label,
every=every,
show_label=show_label,
container=container,
scale=scale,
min_width=min_width,
interactive=interactive,
visible=visible,
elem_id=elem_id,
elem_classes=elem_classes,
value=value,
**kwargs,
)
def get_config(self):
return {
"x": self.x,
"y": self.y,
"value": self.value,
"colors": self.colors,
**IOComponent.get_config(self),
}
@staticmethod
def update(
value: Any | Literal[_Keywords.NO_VALUE] | None = _Keywords.NO_VALUE,
colors: list[str] | None = None,
label: str | None = None,
show_label: bool | None = None,
container: bool | None = None,
scale: int | None = None,
min_width: int | None = None,
interactive: bool | None = None,
visible: bool | None = None,
):
return {
"colors": colors,
"label": label,
"show_label": show_label,
"container": container,
"scale": scale,
"min_width": min_width,
"interactive": interactive,
"visible": visible,
"value": value,
"__type__": "update",
}
def preprocess(self, x: dict | None) -> pd.DataFrame | None:
"""
Parameters:
x: Dict with keys 'data': 2D array of str, numeric, or bool data, 'headers': list of strings for header names, 'range': optional two element list designating start of end of subrange.
Returns:
Dataframe of timeseries data
"""
if x is None:
return x
elif x.get("is_file"):
dataframe = pd.read_csv(x["name"])
else:
dataframe = pd.DataFrame(data=x["data"], columns=x["headers"])
if x.get("range") is not None:
dataframe = dataframe.loc[dataframe[self.x or 0] >= x["range"][0]]
dataframe = dataframe.loc[dataframe[self.x or 0] <= x["range"][1]]
return dataframe
def postprocess(self, y: str | pd.DataFrame | None) -> dict | None:
"""
Parameters:
y: csv or dataframe with timeseries data
Returns:
JSON object with key 'headers' for list of header names, 'data' for 2D array of string or numeric data
"""
if y is None:
return None
if isinstance(y, str):
dataframe = pd.read_csv(y)
return {
"headers": dataframe.columns.values.tolist(),
"data": dataframe.values.tolist(),
}
if isinstance(y, pd.DataFrame):
return {"headers": y.columns.values.tolist(), "data": y.values.tolist()}
raise ValueError("Cannot process value as Timeseries data")
def as_example(self, input_data: str | None) -> str:
return Path(input_data).name if input_data else ""
|