Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: code samples for Series.{add, replace, unique, T, transpose} #287

Merged
merged 4 commits into from
Dec 26, 2023
Merged

docs: code samples for Series.{add, replace, unique, T, transpose} #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3641609
docs: code samples for `Series.{add, replace, unique, T, transpose}`
shobsi Dec 21, 2023
be29b4b
place Examples before Args
shobsi Dec 21, 2023
958b8dc
Merge remote-tracking branch 'refs/remotes/github/main' into shobs-co…
shobsi Dec 21, 2023
8d810a6
Merge branch 'main' into shobs-code-samples-add-etc
Genesis929 Dec 26, 2023
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
4 changes: 2 additions & 2 deletions third_party/bigframes_vendored/pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4371,7 +4371,7 @@ def stack(self, level=-1):
BigQuery DataFrames does not support stack operations that would
combine columns of different dtypes.

**Example:**
**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None
Expand Down Expand Up @@ -4410,7 +4410,7 @@ def unstack(self, level=-1):
If the index is not a MultiIndex, the output will be a Series
(the analogue of stack when the columns are not a MultiIndex).

**Example:**
**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None
Expand Down
190 changes: 189 additions & 1 deletion third_party/bigframes_vendored/pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,13 +143,51 @@ def name(self) -> Hashable:

@property
def T(self) -> Series:
"""Return the transpose, which is by definition self."""
"""Return the transpose, which is by definition self.

**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None

>>> s = bpd.Series(['Ant', 'Bear', 'Cow'])
>>> s
0 Ant
1 Bear
2 Cow
dtype: string

>>> s.T
0 Ant
1 Bear
2 Cow
dtype: string

"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

def transpose(self) -> Series:
"""
Return the transpose, which is by definition self.

**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None

>>> s = bpd.Series(['Ant', 'Bear', 'Cow'])
>>> s
0 Ant
1 Bear
2 Cow
dtype: string

>>> s.transpose()
0 Ant
1 Bear
2 Cow
dtype: string

Returns:
Series: Series.
"""
Expand Down Expand Up @@ -539,6 +577,36 @@ def nunique(self) -> int:
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

def unique(self) -> Series:
"""
Return unique values of Series object.

Uniques are returned in order of appearance. Hash table-based unique,
therefore does NOT sort.

**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None

>>> s = bpd.Series([2, 1, 3, 3], name='A')
>>> s
0 2
1 1
2 3
3 3
Name: A, dtype: Int64
>>> s.unique()
0 2
1 1
2 3
Name: A, dtype: Int64

Returns:
Series: The unique values returned as a Series.
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

def mode(self) -> Series:
"""
Return the mode(s) of the Series.
Expand Down Expand Up @@ -1405,6 +1473,77 @@ def replace(
This differs from updating with ``.loc`` or ``.iloc``, which require
you to specify a location to update with some value.

**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None

>>> s = bpd.Series([1, 2, 3, 4, 5])
>>> s
0 1
1 2
2 3
3 4
4 5
dtype: Int64

>>> s.replace(1, 5)
0 5
1 2
2 3
3 4
4 5
dtype: Int64

You can replace a list of values:

>>> s.replace([1, 3, 5], -1)
0 -1
1 2
2 -1
3 4
4 -1
dtype: Int64

You can use a replacement mapping:

>>> s.replace({1: 5, 3: 10})
0 5
1 2
2 10
3 4
4 5
dtype: Int64

With a string Series you can use a simple string replacement or a regex
replacement:

>>> s = bpd.Series(["Hello", "Another Hello"])
>>> s.replace("Hello", "Hi")
0 Hi
1 Another Hello
dtype: string

>>> s.replace("Hello", "Hi", regex=True)
0 Hi
1 Another Hi
dtype: string

>>> s.replace("^Hello", "Hi", regex=True)
0 Hi
1 Another Hello
dtype: string

>>> s.replace("Hello$", "Hi", regex=True)
0 Hi
1 Another Hi
dtype: string

>>> s.replace("[Hh]e", "__", regex=True)
0 __llo
1 Anot__r __llo
dtype: string

Args:
to_replace (str, regex, list, int, float or None):
How to find the values that will be replaced.
Expand Down Expand Up @@ -1702,6 +1841,55 @@ def add(self, other) -> Series:
Equivalent to ``series + other``, but with support to substitute a fill_value for
missing data in either one of the inputs.

**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None

>>> a = bpd.Series([1, 2, 3, bpd.NA])
>>> a
0 1.0
1 2.0
2 3.0
3 <NA>
dtype: Float64

>>> b = bpd.Series([10, 20, 30, 40])
>>> b
0 10
1 20
2 30
3 40
dtype: Int64

>>> a.add(b)
0 11.0
1 22.0
2 33.0
3 <NA>
dtype: Float64

You can also use the mathematical operator ``+``:

>>> a + b
0 11.0
1 22.0
2 33.0
3 <NA>
dtype: Float64

Adding two Series with explicit indexes:

>>> a = bpd.Series([1, 2, 3, 4], index=['a', 'b', 'c', 'd'])
>>> b = bpd.Series([10, 20, 30, 40], index=['a', 'b', 'd', 'e'])
>>> a.add(b)
a 11
b 22
c <NA>
d 34
e <NA>
dtype: Int64

Args:
other (Series, or scalar value):

Expand Down