Class Series (0.9.0)

Version 0.9.0

• 1.26.0 (latest)
• 1.25.0
• 1.24.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.1
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.1
• 0.19.2
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0

Series(*args, **kwargs)

N-dimensional analogue of DataFrame. Store multi-dimensional in a size-mutable, labeled data structure

Properties

T

Return the transpose, which is by definition self.

at

Access a single value for a row/column label pair.

dt

Accessor object for datetime-like properties of the Series values.

Returns
Type	Description
bigframes.operations.datetimes.DatetimeMethods	An accessor containing datetime methods.

dtype

Return the dtype object of the underlying data.

dtypes

Return the dtype object of the underlying data.

empty

Indicates whether Series/DataFrame is empty.

True if Series/DataFrame is entirely empty (no items), meaning any of the axes are of length 0.

Note: If Series/DataFrame contains only NA values, it is still not considered empty.

Returns
Type	Description
bool	If Series/DataFrame is empty, return True, if not return False.

iat

Access a single value for a row/column pair by integer position.

iloc

Purely integer-location based indexing for selection by position.

index

The index (axis labels) of the Series.

is_monotonic_decreasing

Return boolean if values in the object are monotonically decreasing.

is_monotonic_increasing

Return boolean if values in the object are monotonically increasing.

loc

Access a group of rows and columns by label(s) or a boolean array.

.loc[] is primarily label based, but may also be used with a boolean array.

Allowed inputs are:

• A single label, e.g. 5 or 'a', (note that 5 is interpreted as a label of the index, and never as an integer position along the index).
• A list of labels, e.g. ['a', 'b', 'c'].
• A boolean series of the same length as the axis being sliced, e.g. [True, False, True].
• An alignable Index. The index of the returned selection will be the input.
• Not supported yet An alignable boolean Series. The index of the key will be aligned before masking.
• Not supported yet A slice object with labels, e.g. 'a':'f'. Note: contrary to usual python slices, both the start and the stop are included.
• Not supported yet A callable function with one argument (the calling Series or DataFrame) that returns valid output for indexing (one of the above).

Exceptions
Type	Description
NotImplementError	if the inputs are not supported.

name

Return the name of the Series.

The name of a Series becomes its index or column name if it is used to form a DataFrame. It is also used whenever displaying the Series using the interpreter.

Returns
Type	Description
hashable object	The name of the Series, also the column name if part of a DataFrame.

ndim

Return an int representing the number of axes / array dimensions.

Returns
Type	Description
int	Return 1 if Series. Otherwise return 2 if DataFrame.

query_job

BigQuery job metadata for the most recent query.

shape

Return a tuple of the shape of the underlying data.

size

Return an int representing the number of elements in this object.

Returns
Type	Description
int	Return the number of rows if Series. Otherwise return the number of rows times number of columns if DataFrame.

str

Vectorized string functions for Series and Index.

NAs stay NA unless handled otherwise by a particular method. Patterned after Python’s string methods, with some inspiration from R’s stringr package.

Returns
Type	Description
bigframes.operations.strings.StringMethods	An accessor containing string methods.

struct

Accessor object for struct properties of the Series values.

Returns
Type	Description
bigframes.operations.structs.StructAccessor	An accessor containing struct methods.

values

API documentation for values property.

Methods

__array_ufunc__

__array_ufunc__(
    ufunc: numpy.ufunc, method: str, *inputs, **kwargs
) -> bigframes.series.Series

Used to support numpy ufuncs. See: https://numpy.org/doc/stable/reference/ufuncs.html

__rmatmul__

__rmatmul__(other)

Matrix multiplication using binary @ operator in Python>=3.5.

abs

abs() -> bigframes.series.Series

Return a Series/DataFrame with absolute numeric value of each element.

This function only applies to elements that are all numeric.

add

add(other: float | int | Series) -> Series

Return addition of Series and other, element-wise (binary operator add).

Equivalent to series + other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

add_prefix

add_prefix(prefix: str, axis: int | str | None = None) -> Series

Prefix labels with string prefix.

For Series, the row labels are prefixed. For DataFrame, the column labels are prefixed.

Parameters
Name	Description
prefix	str The string to add before each label.
axis	int or str or None, default None {{0 or 'index', 1 or 'columns', None}}, default None. Axis to add prefix on.

add_suffix

add_suffix(suffix: str, axis: int | str | None = None) -> Series

Suffix labels with string suffix.

For Series, the row labels are suffixed. For DataFrame, the column labels are suffixed.

agg

agg(func: str | typing.Sequence[str]) -> scalars.Scalar | Series

Aggregate using one or more operations over the specified axis.

Parameter
Name	Description
func	function Function to use for aggregating the data. Accepted combinations are: string function name, list of function names, e.g. ['sum', 'mean'].

Returns
Type	Description
scalar or Series	Aggregated results

aggregate

aggregate(func: str | typing.Sequence[str]) -> scalars.Scalar | Series

Aggregate using one or more operations over the specified axis.

Parameter
Name	Description
func	function Function to use for aggregating the data. Accepted combinations are: string function name, list of function names, e.g. ['sum', 'mean'].

Returns
Type	Description
scalar or Series	Aggregated results

all

all() -> bool

Return whether all elements are True, potentially over an axis.

Returns True unless there at least one element within a Series or along a DataFrame axis that is False or equivalent (e.g. zero or empty).

Returns
Type	Description
scalar or Series	If level is specified, then, Series is returned; otherwise, scalar is returned.

any

any() -> bool

Return whether any element is True, potentially over an axis.

Returns False unless there is at least one element within a series or along a Dataframe axis that is True or equivalent (e.g. non-zero or non-empty).

Returns
Type	Description
scalar or Series	If level is specified, then, Series is returned; otherwise, scalar is returned.

apply

apply(func) -> bigframes.series.Series

Invoke function on values of Series.

Can be ufunc (a NumPy function that applies to the entire Series) or a Python function that only works on single values.

Parameter
Name	Description
func	function Python function or NumPy ufunc to apply.

Returns
Type	Description
bigframes.series.Series	If func returns a Series object the result will be a DataFrame.

argmax

argmax() -> int

Return int position of the smallest value in the Series.

If the minimum is achieved in multiple locations, the first row position is returned.

Returns
Type	Description
Series	Row position of the maximum value.

argmin

argmin() -> int

Return int position of the largest value in the Series.

If the maximum is achieved in multiple locations, the first row position is returned.

Returns
Type	Description
Series	Row position of the minimum value.

astype

astype(
    dtype: typing.Union[
        typing.Literal[
            "boolean",
            "Float64",
            "Int64",
            "string",
            "string[pyarrow]",
            "timestamp[us, tz=UTC][pyarrow]",
            "timestamp[us][pyarrow]",
            "date32[day][pyarrow]",
            "time64[us][pyarrow]",
        ],
        pandas.core.arrays.boolean.BooleanDtype,
        pandas.core.arrays.floating.Float64Dtype,
        pandas.core.arrays.integer.Int64Dtype,
        pandas.core.arrays.string_.StringDtype,
        pandas.core.dtypes.dtypes.ArrowDtype,
    ]
) -> bigframes.series.Series

Cast a pandas object to a specified dtype dtype.

Parameter
Name	Description
dtype	str or pandas.ExtensionDtype A dtype supported by BigQuery DataFrame include 'boolean','Float64','Int64', 'string', 'tring[pyarrow]','timestamp[us, tz=UTC][pyarrow]', 'timestampus][pyarrow]','date32day][pyarrow]','time64us][pyarrow]' A pandas.ExtensionDtype include pandas.BooleanDtype(), pandas.Float64Dtype(), pandas.Int64Dtype(), pandas.StringDtype(storage="pyarrow"), pd.ArrowDtype(pa.date32()), pd.ArrowDtype(pa.time64("us")), pd.ArrowDtype(pa.timestamp("us")), pd.ArrowDtype(pa.timestamp("us", tz="UTC")).

between

between(left, right, inclusive="both")

Return boolean Series equivalent to left <= series <= right.

This function returns a boolean vector containing True wherever the corresponding Series element is between the boundary values left and right. NA values are treated as False.

Parameters
Name	Description
left	scalar or list-like Left boundary.
right	scalar or list-like Right boundary.
inclusive	{"both", "neither", "left", "right"} Include boundaries. Whether to set each bound as closed or open.

Returns
Type	Description
Series	Series representing whether each element is between left and right (inclusive).

bfill

bfill(*, limit: typing.Optional[int] = None) -> bigframes.series.Series

Fill NA/NaN values by using the next valid observation to fill the gap.

Returns
Type	Description
Series/DataFrame or None	Object with missing values filled.

clip

clip(lower, upper)

Trim values at input threshold(s).

Assigns values outside boundary to boundary values. Thresholds can be singular values or array like, and in the latter case the clipping is performed element-wise in the specified axis.

Parameters
Name	Description
lower	float or array-like, default None Minimum threshold value. All values below this threshold will be set to it. A missing threshold (e.g NA) will not clip the value.
upper	float or array-like, default None Maximum threshold value. All values above this threshold will be set to it. A missing threshold (e.g NA) will not clip the value.

copy

copy() -> bigframes.series.Series

Make a copy of this object's indices and data.

A new object will be created with a copy of the calling object's data and indices. Modifications to the data or indices of the copy will not be reflected in the original object.

corr

corr(other: bigframes.series.Series, method="pearson", min_periods=None) -> float

Compute the correlation with the other Series. Non-number values are ignored in the computation.

Uses the "Pearson" method of correlation. Numbers are converted to float before calculation, so the result may be unstable.

Parameters
Name	Description
other	Series The series with which this is to be correlated.
method	string, default "pearson" Correlation method to use - currently only "pearson" is supported.
min_periods	int, default None The minimum number of observations needed to return a result. Non-default values are not yet supported, so a result will be returned for at least two observations.

count

count() -> int

Return number of non-NA/null observations in the Series.

Returns
Type	Description
int or Series (if level specified)	Number of non-null values in the Series.

cummax

cummax() -> bigframes.series.Series

Return cumulative maximum over a DataFrame or Series axis.

Returns a DataFrame or Series of the same size containing the cumulative maximum.

Parameter
Name	Description
axis	{{0 or 'index', 1 or 'columns'}}, default 0 The index or the name of the axis. 0 is equivalent to None or 'index'. For Series this parameter is unused and defaults to 0.

Returns
Type	Description
bigframes.series.Series	Return cumulative maximum of scalar or Series.

cummin

cummin() -> bigframes.series.Series

Return cumulative minimum over a DataFrame or Series axis.

Returns a DataFrame or Series of the same size containing the cumulative minimum.

Parameters
Name	Description
axis	{0 or 'index', 1 or 'columns'}, default 0 The index or the name of the axis. 0 is equivalent to None or 'index'. For Series this parameter is unused and defaults to 0.
skipna	bool, default True Exclude NA/null values. If an entire row/column is NA, the result will be NA.

Returns
Type	Description
bigframes.series.Series	Return cumulative minimum of scalar or Series.

cumprod

cumprod() -> bigframes.series.Series

Return cumulative product over a DataFrame or Series axis.

Returns a DataFrame or Series of the same size containing the cumulative product.

Returns
Type	Description
bigframes.series.Series	Return cumulative sum of scalar or Series.

cumsum

cumsum() -> bigframes.series.Series

Return cumulative sum over a DataFrame or Series axis.

Returns a DataFrame or Series of the same size containing the cumulative sum.

Parameter
Name	Description
axis	{0 or 'index', 1 or 'columns'}, default 0 The index or the name of the axis. 0 is equivalent to None or 'index'. For Series this parameter is unused and defaults to 0.

Returns
Type	Description
scalar or Series	Return cumulative sum of scalar or Series.

diff

diff(periods: int = 1) -> bigframes.series.Series

First discrete difference of element.

Calculates the difference of a {klass} element compared with another element in the {klass} (default is element in previous row).

Parameter
Name	Description
periods	int, default 1 Periods to shift for calculating difference, accepts negative values.

Returns
Type	Description
{klass}	First differences of the Series.

div

div(other: float | int | Series) -> Series

Return floating division of Series and other, element-wise (binary operator truediv).

Equivalent to series / other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

divide

divide(other: float | int | Series) -> Series

Return floating division of Series and other, element-wise (binary operator truediv).

Equivalent to series / other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

divmod

divmod(other) -> typing.Tuple[bigframes.series.Series, bigframes.series.Series]

Return integer division and modulo of Series and other, element-wise (binary operator divmod).

Equivalent to divmod(series, other).

dot

dot(other)

Compute the dot product between the Series and the columns of other.

This method computes the dot product between the Series and another one, or the Series and each columns of a DataFrame, or the Series and each columns of an array.

It can also be called using self @ other in Python >= 3.5.

Note: The Series and other has to share the same index if other is a Series or a DataFrame. BigQuery Dataframes does not validate this property and will produce incorrect results if indices are not equal.

Parameter
Name	Description
other	Series The other object to compute the dot product with its columns.

Returns
Type	Description
scalar, Series or numpy.ndarray	Return the dot product of the Series and other if other is a Series, the Series of the dot product of Series and each rows of other if other is a DataFrame or a numpy.ndarray between the Series and each columns of the numpy array.

drop

drop(
    labels: typing.Optional[typing.Any] = None,
    *,
    axis: typing.Union[int, str] = 0,
    index: typing.Optional[typing.Any] = None,
    columns: typing.Optional[
        typing.Union[typing.Hashable, typing.Iterable[typing.Hashable]]
    ] = None,
    level: typing.Optional[typing.Union[str, int]] = None
) -> bigframes.series.Series

Return Series with specified index labels removed.

Remove elements of a Series based on specifying the index labels. When using a multi-index, labels on different levels can be removed by specifying the level.

Parameter
Name	Description
labels	single label or list-like Index labels to drop.

Exceptions
Type	Description
KeyError	If none of the labels are found in the index.

Returns
Type	Description
bigframes.series.Series	Series with specified index labels removed or None if inplace=True.

drop_duplicates

drop_duplicates(*, keep: str = "first") -> bigframes.series.Series

Return Series with duplicate values removed.

Parameter
Name	Description
keep	{'first', 'last', False}, default 'first' Method to handle dropping duplicates: 'first' : Drop duplicates except for the first occurrence. 'last' : Drop duplicates except for the last occurrence. False : Drop all duplicates.

Returns
Type	Description
bigframes.series.Series	Series with duplicates dropped or None if inplace=True.

droplevel

droplevel(level: LevelsType, axis: int | str = 0)

Return Series with requested index / column level(s) removed.

Parameters
Name	Description
level	int, str, or list-like If a string is given, must be the name of a level If list-like, elements must be names or positional indexes of levels.
axis	{0 or 'index', 1 or 'columns'}, default 0 For Series this parameter is unused and defaults to 0.

dropna

dropna(
    *,
    axis: int = 0,
    inplace: bool = False,
    how: typing.Optional[str] = None,
    ignore_index: bool = False
) -> bigframes.series.Series

Return a new Series with missing values removed.

Parameters
Name	Description
axis	0 or 'index' Unused. Parameter needed for compatibility with DataFrame.
inplace	bool, default False Unsupported, do not set.
how	str, optional Not in use. Kept for compatibility.

Returns
Type	Description
Series	Series with NA entries dropped from it.

duplicated

duplicated(keep: str = "first") -> bigframes.series.Series

Indicate duplicate Series values.

Duplicated values are indicated as True values in the resulting Series. Either all duplicates, all except the first or all except the last occurrence of duplicates can be indicated.

Parameter
Name	Description
keep	{'first', 'last', False}, default 'first' Method to handle dropping duplicates: 'first' : Mark duplicates as True except for the first occurrence. 'last' : Mark duplicates as True except for the last occurrence. False : Mark all duplicates as True.

Returns
Type	Description
bigframes.series.Series	Series indicating whether each value has occurred in the preceding values.

eq

eq(other: object) -> bigframes.series.Series

Return equal of Series and other, element-wise (binary operator eq).

Equivalent to other == series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
Series	The result of the operation.

equals

equals(
    other: typing.Union[bigframes.series.Series, bigframes.dataframe.DataFrame]
) -> bool

API documentation for equals method.

expanding

expanding(min_periods: int = 1) -> bigframes.core.window.Window

Provide expanding window calculations.

Parameter
Name	Description
min_periods	int, default 1 Minimum number of observations in window required to have a value; otherwise, result is np.nan.

Returns
Type	Description
bigframes.core.window.Window	Expanding subclass.

ffill

ffill(*, limit: typing.Optional[int] = None) -> bigframes.series.Series

Fill NA/NaN values by propagating the last valid observation to next valid.

Returns
Type	Description
Series/DataFrame or None	Object with missing values filled.

fillna

fillna(value=None) -> bigframes.series.Series

Fill NA/NaN values using the specified method.

Parameter
Name	Description
value	scalar, dict, Series, or DataFrame, default None Value to use to fill holes (e.g. 0).

Returns
Type	Description
Series or None	Object with missing values filled or None.

filter

filter(
    items: typing.Optional[typing.Iterable] = None,
    like: typing.Optional[str] = None,
    regex: typing.Optional[str] = None,
    axis: typing.Optional[typing.Union[str, int]] = None,
) -> bigframes.series.Series

Subset the dataframe rows or columns according to the specified index labels.

Note that this routine does not filter a dataframe on its contents. The filter is applied to the labels of the index.

Parameters
Name	Description
items	list-like Keep labels from axis which are in items.
like	str Keep labels from axis for which "like in label == True".
regex	str (regular expression) Keep labels from axis for which re.search(regex, label) == True.
axis	{0 or 'index', 1 or 'columns', None}, default None The axis to filter on, expressed either as an index (int) or axis name (str). By default this is the info axis, 'columns' for DataFrame. For Series this parameter is unused and defaults to None.

floordiv

floordiv(other: float | int | Series) -> Series

Return integer division of Series and other, element-wise (binary operator floordiv).

Equivalent to series // other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

ge

ge(other) -> bigframes.series.Series

Get 'greater than or equal to' of Series and other, element-wise (binary operator >=).

Equivalent to series >= other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

get

get(key, default=None)

Get item from object for given key (ex: DataFrame column).

Returns default value if not found.

groupby

groupby(
    by: typing.Union[
        blocks.Label, Series, typing.Sequence[typing.Union[blocks.Label, Series]]
    ] = None,
    axis=0,
    level: typing.Optional[
        int | str | typing.Sequence[int] | typing.Sequence[str]
    ] = None,
    as_index: bool = True,
    *,
    dropna: bool = True
) -> bigframes.core.groupby.SeriesGroupBy

Group Series using a mapper or by a Series of columns.

A groupby operation involves some combination of splitting the object, applying a function, and combining the results. This can be used to group large amounts of data and compute operations on these groups.

Parameters
Name	Description
by	mapping, function, label, pd.Grouper or list of such, default None Used to determine the groups for the groupby. If by is a function, it's called on each value of the object's index. If a dict or Series is passed, the Series or dict VALUES will be used to determine the groups (the Series' values are first aligned; see .align() method). If a list or ndarray of length equal to the selected axis is passed (see the groupby user guide https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html#splitting-an-object-into-groups_), the values are used as-is to determine the groups. A label or list of labels may be passed to group by the columns in self. Notice that a tuple is interpreted as a (single) key.
axis	{0 or 'index', 1 or 'columns'}, default 0 Split along rows (0) or columns (1). For Series this parameter is unused and defaults to 0.
level	int, level name, or sequence of such, default None If the axis is a MultiIndex (hierarchical), group by a particular level or levels. Do not specify both by and level.
as_index	bool, default True Return object with group labels as the index. Only relevant for DataFrame input. as_index=False is effectively "SQL-style" grouped output. This argument has no effect on filtrations (see the "filtrations in the user guide" https://pandas.pydata.org/docs/dev/user_guide/groupby.html#filtration), such as head(), tail(), nth() and in transformations (see the "transformations in the user guide" https://pandas.pydata.org/docs/dev/user_guide/groupby.html#transformation).

Returns
Type	Description
bigframes.core.groupby.SeriesGroupBy	Returns a groupby object that contains information about the groups.

gt

gt(other) -> bigframes.series.Series

Get 'less than or equal to' of Series and other, element-wise (binary operator <=).

Equivalent to series <= other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

head

head(n: int = 5) -> bigframes.series.Series

Return the first n rows.

This function returns the first n rows for the object based on position. It is useful for quickly testing if your object has the right type of data in it.

Not yet supported For negative values of n, this function returns all rows except the last |n| rows, equivalent to df[:n].

If n is larger than the number of rows, this function returns all rows.

Parameter
Name	Description
n	int, default 5 Default 5. Number of rows to select.

idxmax

idxmax() -> typing.Hashable

Return the row label of the maximum value.

If multiple values equal the maximum, the first row label with that value is returned.

Returns
Type	Description
Index	Label of the maximum value.

idxmin

idxmin() -> typing.Hashable

Return the row label of the minimum value.

If multiple values equal the minimum, the first row label with that value is returned.

Returns
Type	Description
Index	Label of the minimum value.

isin

isin(values) -> "Series" | None

Whether elements in Series are contained in values.

Return a boolean Series showing whether each element in the Series matches an element in the passed sequence of values exactly.

Note: This function treats all NaN-like values(e.g., pd.NA, numpy.nan, None) as the same. That is, if any form of NaN is present in values, all forms of NaN in the series will be considered a match. (though pandas may not)

Parameter
Name	Description
values	list-like The sequence of values to test. Passing in a single string will raise a TypeError. Instead, turn a single string into a list of one element.

Exceptions
Type	Description
TypeError	If input is not list-like.

Returns
Type	Description
bigframes.series.Series	Series of booleans indicating if each element is in values.

isna

isna() -> bigframes.series.Series

Detect missing values.

Return a boolean same-sized object indicating if the values are NA. NA values get mapped to True values. Everything else gets mapped to False values. Characters such as empty strings '' or numpy.inf are not considered NA values.

isnull

isnull() -> bigframes.series.Series

Detect missing values.

Return a boolean same-sized object indicating if the values are NA. NA values get mapped to True values. Everything else gets mapped to False values. Characters such as empty strings '' or numpy.inf are not considered NA values.

kurt

kurt()

Return unbiased kurtosis over requested axis.

Kurtosis obtained using Fisher’s definition of kurtosis (kurtosis of normal == 0.0). Normalized by N-1.

Returns
Type	Description
scalar or scalar	Unbiased kurtosis over requested axis.

kurtosis

kurtosis()

Return unbiased kurtosis over requested axis.

Kurtosis obtained using Fisher’s definition of kurtosis (kurtosis of normal == 0.0). Normalized by N-1.

Returns
Type	Description
scalar or scalar	Unbiased kurtosis over requested axis.

le

le(other) -> bigframes.series.Series

Get 'less than or equal to' of Series and other, element-wise (binary operator <=).

Equivalent to series <= other, but with support to substitute a fill_value for missing data in either one of the inputs.

lt

lt(other) -> bigframes.series.Series

Get 'less than' of Series and other, element-wise (binary operator <).

Equivalent to series < other, but with support to substitute a fill_value for missing data in either one of the inputs.

map

map(
    arg: typing.Union[typing.Mapping, bigframes.series.Series],
    na_action: typing.Optional[str] = None,
    *,
    verify_integrity: bool = False
) -> bigframes.series.Series

Map values of Series according to an input mapping or function.

Used for substituting each value in a Series with another value, that may be derived from a remote function, dict, or a Series.

If arg is a remote function, the overhead for remote functions applies. If mapping with a dict, fully deferred computation is possible. If mapping with a Series, fully deferred computation is only possible if verify_integrity=False.

Note: Bigframes does not yet support dict subclasses that define __missing__ (i.e. provide a method for default values). These are treated the same as dict.

Parameter
Name	Description
arg	function, Mapping, Series remote function, collections.abc.Mapping subclass or Series Mapping correspondence.

Returns
Type	Description
Series	Same index as caller.

mask

mask(cond, other=None) -> bigframes.series.Series

Replace values where the condition is True.

Parameters
Name	Description
cond	bool Series/DataFrame, array-like, or callable Where cond is False, keep the original value. Where True, replace with corresponding value from other. If cond is callable, it is computed on the Series/DataFrame and should return boolean Series/DataFrame or array. The callable must not change input Series/DataFrame (though pandas doesn’t check it).
other	scalar, Series/DataFrame, or callable Entries where cond is True are replaced with corresponding value from other. If other is callable, it is computed on the Series/DataFrame and should return scalar or Series/DataFrame. The callable must not change input Series/DataFrame (though pandas doesn’t check it). If not specified, entries will be filled with the corresponding NULL value (np.nan for numpy dtypes, pd.NA for extension dtypes).

Returns
Type	Description
bigframes.series.Series	Series after the replacement.

max

max() -> typing.Any

Return the maximum of the values over the requested axis.

If you want the index of the maximum, use idxmax. This is the equivalent of the numpy.ndarray method argmax.

mean

mean() -> float

Return the mean of the values over the requested axis.

median

median(*, exact: bool = False) -> float

Return the median of the values over the requested axis.

Parameter
Name	Description
exact	bool. default False Default False. Get the exact median instead of an approximate one. Note: exact=True not yet supported.

min

min() -> typing.Any

Return the maximum of the values over the requested axis.

If you want the index of the minimum, use idxmin. This is the equivalent of the numpy.ndarray method argmin.

mod

mod(other) -> bigframes.series.Series

Return modulo of Series and other, element-wise (binary operator mod).

Equivalent to series % other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

mode

mode() -> bigframes.series.Series

Return the mode(s) of the Series.

The mode is the value that appears most often. There can be multiple modes.

Always returns Series even if only one value is returned.

Returns
Type	Description
bigframes.series.Series	Modes of the Series in sorted order.

mul

mul(other: float | int | Series) -> Series

Return multiplication of Series and other, element-wise (binary operator mul).

Equivalent to other * series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

multiply

multiply(other: float | int | Series) -> Series

Return multiplication of Series and other, element-wise (binary operator mul).

Equivalent to other * series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

ne

ne(other: object) -> bigframes.series.Series

Return not equal of Series and other, element-wise (binary operator ne).

Equivalent to other != series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

nlargest

nlargest(n: int = 5, keep: str = "first") -> bigframes.series.Series

Return the largest n elements.

Parameters
Name	Description
n	int, default 5 Return this many descending sorted values.
keep	{'first', 'last', 'all'}, default 'first' When there are duplicate values that cannot all fit in a Series of n elements: first : return the first n occurrences in order of appearance. last : return the last n occurrences in reverse order of appearance. all : keep all occurrences. This can result in a Series of size larger than n.

Returns
Type	Description
bigframes.series.Series	The n largest values in the Series, sorted in decreasing order.

notna

notna() -> bigframes.series.Series

Detect existing (non-missing) values.

Return a boolean same-sized object indicating if the values are not NA. Non-missing values get mapped to True. Characters such as empty strings '' or numpy.inf are not considered NA values. NA values get mapped to False values.

Returns
Type	Description
NDFrame	Mask of bool values for each element that indicates whether an element is not an NA value.

notnull

notnull() -> bigframes.series.Series

Detect existing (non-missing) values.

Return a boolean same-sized object indicating if the values are not NA. Non-missing values get mapped to True. Characters such as empty strings '' or numpy.inf are not considered NA values. NA values get mapped to False values.

Returns
Type	Description
NDFrame	Mask of bool values for each element that indicates whether an element is not an NA value.

nsmallest

nsmallest(n: int = 5, keep: str = "first") -> bigframes.series.Series

Return the smallest n elements.

Parameters
Name	Description
n	int, default 5 Return this many ascending sorted values.
keep	{'first', 'last', 'all'}, default 'first' When there are duplicate values that cannot all fit in a Series of n elements: first : return the first n occurrences in order of appearance. last : return the last n occurrences in reverse order of appearance. all : keep all occurrences. This can result in a Series of size larger than n.

Returns
Type	Description
bigframes.series.Series	The n smallest values in the Series, sorted in increasing order.

nunique

nunique() -> int

Return number of unique elements in the object.

Excludes NA values by default.

Returns
Type	Description
int	number of unique elements in the object.

pad

pad(*, limit: typing.Optional[int] = None) -> bigframes.series.Series

Fill NA/NaN values by propagating the last valid observation to next valid.

Returns
Type	Description
Series/DataFrame or None	Object with missing values filled.

pct_change

pct_change(periods: int = 1) -> bigframes.series.Series

Fractional change between the current and a prior element.

Computes the fractional change from the immediately previous row by default. This is useful in comparing the fraction of change in a time series of elements.

Note: Despite the name of this method, it calculates fractional change (also known as per unit change or relative change) and not percentage change. If you need the percentage change, multiply these values by 100.

Parameter
Name	Description
periods	int, default 1 Periods to shift for forming percent change.

Returns
Type	Description
Series or DataFrame	The same type as the calling object.

pow

pow(other: float | int | Series) -> Series

Return Exponential power of series and other, element-wise (binary operator pow).

Equivalent to series ** other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

prod

prod() -> float

Return the product of the values over the requested axis.

product

product() -> float

Return the product of the values over the requested axis.

radd

radd(other: float | int | Series) -> Series

Return addition of Series and other, element-wise (binary operator radd).

Equivalent to other + series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

rank

rank(
    axis=0,
    method: str = "average",
    numeric_only=False,
    na_option: str = "keep",
    ascending: bool = True,
) -> bigframes.series.Series

Compute numerical data ranks (1 through n) along axis.

By default, equal values are assigned a rank that is the average of the ranks of those values.

Parameters
Name	Description
method	{'average', 'min', 'max', 'first', 'dense'}, default 'average' How to rank the group of records that have the same value (i.e. ties): average: average rank of the group, min: lowest rank in the group max: highest rank in the group, first: ranks assigned in order they appear in the array, dense`: like 'min', but rank always increases by 1 between groups.
numeric_only	bool, default False For DataFrame objects, rank only numeric columns if set to True.
na_option	{'keep', 'top', 'bottom'}, default 'keep' How to rank NaN values: keep: assign NaN rank to NaN values, , top: assign lowest rank to NaN values, bottom: assign highest rank to NaN values.
ascending	bool, default True Whether or not the elements should be ranked in ascending order.

Returns
Type	Description
same type as caller	Return a Series or DataFrame with data ranks as values.

rdiv

rdiv(other: float | int | Series) -> Series

Return floating division of Series and other, element-wise (binary operator rtruediv).

Equivalent to other / series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

rdivmod

rdivmod(other) -> typing.Tuple[bigframes.series.Series, bigframes.series.Series]

Return integer division and modulo of Series and other, element-wise (binary operator rdivmod).

Equivalent to other divmod series.

reindex

reindex(index=None, *, validate: typing.Optional[bool] = None)

Conform Series to new index with optional filling logic.

Places NA/NaN in locations having no value in the previous index. A new object is produced unless the new index is equivalent to the current one and copy=False.

Parameter
Name	Description
index	array-like, optional New labels for the index. Preferably an Index object to avoid duplicating data.

Returns
Type	Description
Series	Series with changed index.

reindex_like

reindex_like(
    other: bigframes.series.Series, *, validate: typing.Optional[bool] = None
)

Return an object with matching indices as other object.

Conform the object to the same index on all axes. Optional filling logic, placing Null in locations having no value in the previous index.

Parameter
Name	Description
other	Object of the same data type Its row and column indices are used to define the new indices of this object.

Returns
Type	Description
Series or DataFrame	Same type as caller, but with changed indices on each axis.

rename

rename(
    index: typing.Optional[
        typing.Union[typing.Hashable, typing.Mapping[typing.Any, typing.Any]]
    ] = None,
    **kwargs
) -> bigframes.series.Series

Alter Series index labels or name.

Function / dict values must be unique (1-to-1). Labels not contained in a dict / Series will be left as-is. Extra labels listed don't throw an error.

Alternatively, change Series.name with a scalar value.

Parameter
Name	Description
index	scalar, hashable sequence, dict-like or function optional Functions or dict-like are transformations to apply to the index. Scalar or hashable sequence-like will alter the Series.name attribute.

Returns
Type	Description
bigframes.series.Series	Series with index labels.

rename_axis

rename_axis(
    mapper: typing.Union[typing.Hashable, typing.Sequence[typing.Hashable]], **kwargs
) -> bigframes.series.Series

Set the name of the axis for the index or columns.

Parameter
Name	Description
mapper	scalar, list-like, optional Value to set the axis name attribute.

Returns
Type	Description
bigframes.series.Series	Series with the name of the axis set.

reorder_levels

reorder_levels(order: LevelsType, axis: int | str = 0)

Rearrange index levels using input order.

May not drop or duplicate levels.

Parameters
Name	Description
order	list of int representing new level order Reference level by number or key.
axis	{0 or 'index', 1 or 'columns'}, default 0 For Series this parameter is unused and defaults to 0.

replace

replace(
    to_replace: typing.Any,
    value: typing.Optional[typing.Any] = None,
    *,
    regex: bool = False
)

Replace values given in to_replace with value.

Values of the Series/DataFrame are replaced with other values dynamically. This differs from updating with .loc or .iloc, which require you to specify a location to update with some value.

Parameters
Name	Description
to_replace	str, regex, list, int, float or None How to find the values that will be replaced. * numeric, str or regex: - numeric: numeric values equal to to_replace will be replaced with value - str: string exactly matching to_replace will be replaced with value - regex: regexs matching to_replace will be replaced with value * list of str, regex, or numeric: - First, if to_replace and value are both lists, they must be the same length. - Second, if regex=True then all of the strings in both lists will be interpreted as regexs otherwise they will match directly. This doesn't matter much for value since there are only a few possible substitution regexes you can use. - str, regex and numeric rules apply as above.
value	scalar, default None Value to replace any values matching to_replace with. For a DataFrame a dict of values can be used to specify which value to use for each column (columns not in the dict will not be filled). Regular expressions, strings and lists or dicts of such objects are also allowed.
regex	bool, default False Whether to interpret to_replace and/or value as regular expressions. If this is True then to_replace must be a string.

Exceptions
Type	Description
TypeError	* If to_replace is not a scalar, array-like, dict, or None * If to_replace is a dict and value is not a list, dict, ndarray, or Series * If to_replace is None and regex is not compilable into a regular expression or is a list, dict, ndarray, or Series. * When replacing multiple bool or datetime64 objects and the arguments to to_replace does not match the type of the value being replaced

Returns
Type	Description
Series/DataFrame	Object after replacement.

reset_index

reset_index(
    *, name: typing.Optional[str] = None, drop: bool = False
) -> bigframes.dataframe.DataFrame | Series

Generate a new DataFrame or Series with the index reset.

This is useful when the index needs to be treated as a column, or when the index is meaningless and needs to be reset to the default before another operation.

Parameters
Name	Description
drop	bool, default False Just reset the index, without inserting it as a column in the new DataFrame.
name	object, optional The name to use for the column containing the original Series values. Uses self.name by default. This argument is ignored when drop is True.

rfloordiv

rfloordiv(other: float | int | Series) -> Series

Return integer division of Series and other, element-wise (binary operator rfloordiv).

Equivalent to other // series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

rmod

rmod(other) -> bigframes.series.Series

Return modulo of Series and other, element-wise (binary operator mod).

Equivalent to series % other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

rmul

rmul(other: float | int | Series) -> Series

Return multiplication of Series and other, element-wise (binary operator mul).

Equivalent to series * others, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
Series	The result of the operation.

rolling

rolling(window: int, min_periods=None) -> bigframes.core.window.Window

Provide rolling window calculations.

Parameters
Name	Description
window	int, timedelta, str, offset, or BaseIndexer subclass Size of the moving window. If an integer, the fixed number of observations used for each window. If a timedelta, str, or offset, the time period of each window. Each window will be a variable sized based on the observations included in the time-period. This is only valid for datetime-like indexes. To learn more about the offsets & frequency strings, please see this link https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases__. If a BaseIndexer subclass, the window boundaries based on the defined get_window_bounds method. Additional rolling keyword arguments, namely min_periods, center, closed and step will be passed to get_window_bounds.
min_periods	int, default None Minimum number of observations in window required to have a value; otherwise, result is np.nan. For a window that is specified by an offset, min_periods will default to 1. For a window that is specified by an integer, min_periods will default to the size of the window.

Returns
Type	Description
bigframes.core.window.Window	Window subclass if a win_type is passed. Rolling subclass if win_type is not passed.

round

round(decimals=0) -> bigframes.series.Series

Round each value in a Series to the given number of decimals.

Parameter
Name	Description
decimals	int, default 0 Number of decimal places to round to. If decimals is negative, it specifies the number of positions to the left of the decimal point.

Returns
Type	Description
bigframes.series.Series	Rounded values of the Series.

rpow

rpow(other: float | int | Series) -> Series

Return Exponential power of series and other, element-wise (binary operator rpow).

Equivalent to other ** series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

rsub

rsub(other: float | int | Series) -> Series

Return subtraction of Series and other, element-wise (binary operator rsub).

Equivalent to other - series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

rtruediv

rtruediv(other: float | int | Series) -> Series

Return floating division of Series and other, element-wise (binary operator rtruediv).

Equivalent to other / series, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

sample

sample(
    n: typing.Optional[int] = None,
    frac: typing.Optional[float] = None,
    *,
    random_state: typing.Optional[int] = None
)

Return a random sample of items from an axis of object.

You can use random_state for reproducibility.

Parameters
Name	Description
n	Optional[int], default None Number of items from axis to return. Cannot be used with frac. Default = 1 if frac = None.
frac	Optional[float], default None Fraction of axis items to return. Cannot be used with n.
random_state	Optional[int], default None Seed for random number generator.

shift

shift(periods: int = 1) -> bigframes.series.Series

Shift index by desired number of periods.

Shifts the index without realigning the data.

Returns
Type	Description
NDFrame	Copy of input object, shifted.

skew

skew()

Return unbiased skew over requested axis.

Normalized by N-1.

sort_index

sort_index(
    *, axis=0, ascending=True, na_position="last"
) -> bigframes.series.Series

Sort Series by index labels.

Returns a new Series sorted by label if inplace argument is False, otherwise updates the original series and returns None.

Parameters
Name	Description
axis	{0 or 'index'} Unused. Parameter needed for compatibility with DataFrame.
ascending	bool or list-like of bools, default True Sort ascending vs. descending. When the index is a MultiIndex the sort direction can be controlled for each level individually.
na_position	{'first', 'last'}, default 'last' If 'first' puts NaNs at the beginning, 'last' puts NaNs at the end. Not implemented for MultiIndex.

Returns
Type	Description
bigframes.series.Series	The original Series sorted by the labels or None if inplace=True.

sort_values

sort_values(
    *, axis=0, ascending=True, kind: str = "quicksort", na_position="last"
) -> bigframes.series.Series

Sort by the values.

Sort a Series in ascending or descending order by some criterion.

Parameters
Name	Description
axis	0 or 'index' Unused. Parameter needed for compatibility with DataFrame.
ascending	bool or list of bools, default True If True, sort values in ascending order, otherwise descending.
kind	str, default to 'quicksort' Choice of sorting algorithm. Accepts 'quicksort’, ‘mergesort’, ‘heapsort’, ‘stable’. Ignored except when determining whether to sort stably. 'mergesort' or 'stable' will result in stable reorder
na_position	{'first' or 'last'}, default 'last' Argument 'first' puts NaNs at the beginning, 'last' puts NaNs at the end.

Returns
Type	Description
bigframes.series.Series	Series ordered by values or None if inplace=True.

std

std() -> float

Return sample standard deviation over requested axis.

Normalized by N-1 by default.

sub

sub(other: float | int | Series) -> Series

Return subtraction of Series and other, element-wise (binary operator sub).

Equivalent to series - other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

subtract

subtract(other: float | int | Series) -> Series

Return subtraction of Series and other, element-wise (binary operator sub).

Equivalent to series - other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

sum

sum() -> float

Return the sum of the values over the requested axis.

This is equivalent to the method numpy.sum.

swaplevel

swaplevel(i: int = -2, j: int = -1)

Swap levels i and j in a MultiIndex.

Default is to swap the two innermost levels of the index.

Parameter
Name	Description
i	j: int or str j: Levels of the indices to be swapped. Can pass level name as string.

Returns
Type	Description
Series	Series with levels swapped in MultiIndex

tail

tail(n: int = 5) -> bigframes.series.Series

Return the last n rows.

This function returns last n rows from the object based on position. It is useful for quickly verifying data, for example, after sorting or appending rows.

For negative values of n, this function returns all rows except the first |n| rows, equivalent to df[|n|:].

If n is larger than the number of rows, this function returns all rows.

Parameter
Name	Description
n	int, default 5 Number of rows to select.

to_csv

to_csv(path_or_buf=None, **kwargs) -> typing.Optional[str]

Write object to a comma-separated values (csv) file.

Parameter
Name	Description
path_or_buf	str, path object, file-like object, or None, default None String, path object (implementing os.PathLike[str]), or file-like object implementing a write() function. If None, the result is returned as a string. If a non-binary file object is passed, it should be opened with newline='', disabling universal newlines. If a binary file object is passed, mode might need to contain a 'b'.

Returns
Type	Description
None or str	If path_or_buf is None, returns the resulting csv format as a string. Otherwise returns None.

to_dict

to_dict(into: type[dict] = <class 'dict'>) -> typing.Mapping

Convert Series to {label -> value} dict or dict-like object.

Parameter
Name	Description
into	class, default dict The collections.abc.Mapping subclass to use as the return object. Can be the actual class or an empty instance of the mapping type you want. If you want a collections.defaultdict, you must pass it initialized.

Returns
Type	Description
collections.abc.Mapping	Key-value representation of Series.

to_excel

to_excel(excel_writer, sheet_name="Sheet1", **kwargs) -> None

Write Series to an Excel sheet.

To write a single Series to an Excel .xlsx file it is only necessary to specify a target file name. To write to multiple sheets it is necessary to create an ExcelWriter object with a target file name, and specify a sheet in the file to write to.

Multiple sheets may be written to by specifying unique sheet_name. With all data written to the file it is necessary to save the changes. Note that creating an ExcelWriter object with a file name that already exists will result in the contents of the existing file being erased.

Parameters
Name	Description
excel_writer	path-like, file-like, or ExcelWriter object File path or existing ExcelWriter.
sheet_name	str, default 'Sheet1' Name of sheet to contain Series.

to_frame

to_frame(
    name: typing.Optional[typing.Hashable] = None,
) -> bigframes.dataframe.DataFrame

Convert Series to DataFrame.

The column in the new dataframe will be named name (the keyword parameter) if the name parameter is provided and not None.

Returns
Type	Description
bigframes.dataframe.DataFrame	DataFrame representation of Series.

to_json

to_json(
    path_or_buf=None,
    orient: typing.Literal[
        "split", "records", "index", "columns", "values", "table"
    ] = "columns",
    **kwargs
) -> typing.Optional[str]

Convert the object to a JSON string.

Note NaN's and None will be converted to null and datetime objects will be converted to UNIX timestamps.

Parameters
Name	Description
path_or_buf	str, path object, file-like object, or None, default None String, path object (implementing os.PathLike[str]), or file-like object implementing a write() function. If None, the result is returned as a string.
orient	{"split", "records", "index", "columns", "values", "table"}, default "columns" Indication of expected JSON string format. 'split' : dict like {{'index' -> [index], 'columns' -> [columns],'data' -> [values]}} 'records' : list like [{{column -> value}}, ... , {{column -> value}}] 'index' : dict like {{index -> {{column -> value}}}} 'columns' : dict like {{column -> {{index -> value}}}} 'values' : just the values array 'table' : dict like {{'schema': {{schema}}, 'data': {{data}}}} Describing the data, where data component is like orient='records'.

Returns
Type	Description
None or str	If path_or_buf is None, returns the resulting json format as a string. Otherwise returns None.

to_latex

to_latex(
    buf=None, columns=None, header=True, index=True, **kwargs
) -> typing.Optional[str]

Render object to a LaTeX tabular, longtable, or nested table.

Parameters
Name	Description
buf	str, Path or StringIO-like, optional, default None Buffer to write to. If None, the output is returned as a string.
columns	list of label, optional The subset of columns to write. Writes all columns by default.
header	bool or list of str, default True Write out the column names. If a list of strings is given, it is assumed to be aliases for the column names.
index	bool, default True Write row names (index).

Returns
Type	Description
str or None	If buf is None, returns the result as a string. Otherwise returns None.

to_list

to_list() -> list

Return a list of the values.

These are each a scalar type, which is a Python scalar (for str, int, float) or a pandas scalar (for Timestamp/Timedelta/Interval/Period).

Returns
Type	Description
list	list of the values

to_markdown

to_markdown(
    buf: typing.IO[str] | None = None, mode: str = "wt", index: bool = True, **kwargs
) -> typing.Optional[str]

Print {klass} in Markdown-friendly format.

Parameters
Name	Description
buf	str, Path or StringIO-like, optional, default None Buffer to write to. If None, the output is returned as a string.
mode	str, optional Mode in which file is opened, "wt" by default.
index	bool, optional, default True Add index (row) labels.

Returns
Type	Description
str	{klass} in Markdown-friendly format.

to_numpy

to_numpy(dtype=None, copy=False, na_value=None, **kwargs) -> numpy.ndarray

A NumPy ndarray representing the values in this Series or Index.

Parameters
Name	Description
dtype	str or numpy.dtype, optional The dtype to pass to numpy.asarray.
copy	bool, default False Whether to ensure that the returned value is not a view on another array. Note that copy=False does not ensure that to_numpy() is no-copy. Rather, copy=True ensure that a copy is made, even if not strictly necessary.
na_value	Any, optional The value to use for missing values. The default value depends on dtype and the type of the array.

Returns
Type	Description
numpy.ndarray	A NumPy ndarray representing the values in this Series or Index.

to_pandas

to_pandas(
    max_download_size: typing.Optional[int] = None,
    sampling_method: typing.Optional[str] = None,
    random_state: typing.Optional[int] = None,
) -> pandas.core.series.Series

Writes Series to pandas Series.

Parameters
Name	Description
max_download_size	int, default None Download size threshold in MB. If max_download_size is exceeded when downloading data (e.g., to_pandas()), the data will be downsampled if bigframes.options.sampling.enable_downsampling is True, otherwise, an error will be raised. If set to a value other than None, this will supersede the global config.
sampling_method	str, default None Downsampling algorithms to be chosen from, the choices are: "head": This algorithm returns a portion of the data from the beginning. It is fast and requires minimal computations to perform the downsampling; "uniform": This algorithm returns uniform random samples of the data. If set to a value other than None, this will supersede the global config.
random_state	int, default None The seed for the uniform downsampling algorithm. If provided, the uniform method may take longer to execute and require more computation. If set to a value other than None, this will supersede the global config.

Returns
Type	Description
pandas.Series	A pandas Series with all rows of this Series if the data_sampling_threshold_mb is not exceeded; otherwise, a pandas Series with downsampled rows of the DataFrame.

to_pickle

to_pickle(path, **kwargs) -> None

Pickle (serialize) object to file.

Parameter
Name	Description
path	str, path object, or file-like object String, path object (implementing os.PathLike[str]), or file-like object implementing a binary write() function. File path where the pickled object will be stored.

to_string

to_string(
    buf=None,
    na_rep="NaN",
    float_format=None,
    header=True,
    index=True,
    length=False,
    dtype=False,
    name=False,
    max_rows=None,
    min_rows=None,
) -> typing.Optional[str]

Render a string representation of the Series.

Parameters
Name	Description
buf	StringIO-like, optional Buffer to write to.
na_rep	str, optional String representation of NaN to use, default 'NaN'.
float_format	one-parameter function, optional Formatter function to apply to columns' elements if they are floats, default None.
header	bool, default True Add the Series header (index name).
index	bool, optional Add index (row) labels, default True.
length	bool, default False Add the Series length.
dtype	bool, default False Add the Series dtype.
name	bool, default False Add the Series name if not None.
max_rows	int, optional Maximum number of rows to show before truncating. If None, show all.
min_rows	int, optional The number of rows to display in a truncated repr (when number of rows is above max_rows).

Returns
Type	Description
str or None	String representation of Series if buf=None, otherwise None.

to_xarray

to_xarray()

Return an xarray object from the pandas object.

Returns
Type	Description
xarray.DataArray or xarray.Dataset	Data in the pandas structure converted to Dataset if the object is a DataFrame, or a DataArray if the object is a Series.

tolist

tolist() -> list

Return a list of the values.

These are each a scalar type, which is a Python scalar (for str, int, float) or a pandas scalar (for Timestamp/Timedelta/Interval/Period).

Returns
Type	Description
list	list of the values

transpose

transpose() -> bigframes.series.Series

Return the transpose, which is by definition self.

truediv

truediv(other: float | int | Series) -> Series

Return floating division of Series and other, element-wise (binary operator truediv).

Equivalent to series / other, but with support to substitute a fill_value for missing data in either one of the inputs.

Returns
Type	Description
bigframes.series.Series	The result of the operation.

unique

unique() -> bigframes.series.Series

API documentation for unique method.

value_counts

value_counts(
    normalize: bool = False,
    sort: bool = True,
    ascending: bool = False,
    *,
    dropna: bool = True
)

Return a Series containing counts of unique values.

The resulting object will be in descending order so that the first element is the most frequently-occurring element. Excludes NA values by default.

Parameters
Name	Description
normalize	bool, default False If True then the object returned will contain the relative frequencies of the unique values.
sort	bool, default True Sort by frequencies.
ascending	bool, default False Sort in ascending order.
dropna	bool, default True Don't include counts of NaN.

Returns
Type	Description
Series	Series containing counts of unique values.

var

var() -> float

Return unbiased variance over requested axis.

Normalized by N-1 by default.

where

where(cond, other=None)

Replace values where the condition is False.

Parameters
Name	Description
cond	bool Series/DataFrame, array-like, or callable Where cond is True, keep the original value. Where False, replace with corresponding value from other. If cond is callable, it is computed on the Series/DataFrame and returns boolean Series/DataFrame or array. The callable must not change input Series/DataFrame (though pandas doesn’t check it).
other	scalar, Series/DataFrame, or callable Entries where cond is False are replaced with corresponding value from other. If other is callable, it is computed on the Series/DataFrame and returns scalar or Series/DataFrame. The callable must not change input Series/DataFrame (though pandas doesn’t check it). If not specified, entries will be filled with the corresponding NULL value (np.nan for numpy dtypes, pd.NA for extension dtypes).

Returns
Type	Description
bigframes.series.Series	Series after the replacement.