Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: code samples for DataFrame.rename, Series.rename #293

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

Merged
merged 4 commits into from
Jan 2, 2024
Merged

docs: code samples for DataFrame.rename, Series.rename #293

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
1d55be4
docs: code samples for `DataFrame.rename`, `Series.rename`
shobsi Dec 28, 2023
ec7f39a
improve the `size` code samples a bit
shobsi Dec 28, 2023
56fc51c
Merge remote-tracking branch 'refs/remotes/github/main' into shobs-co…
shobsi Dec 28, 2023
81cf8d1
Merge branch 'main' into shobs-code-samples-dropna-rename-etc
ashleyxuu Jan 2, 2024
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
24 changes: 24 additions & 0 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 @@ -1146,6 +1146,30 @@ def rename(
Dict values must be unique (1-to-1). Labels not contained in a dict
will be left as-is. Extra labels listed don't throw an error.

**Examples:**

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

>>> df = bpd.DataFrame({"A": [1, 2, 3], "B": [4, 5, 6]})
>>> df
A B
0 1 4
1 2 5
2 3 6
<BLANKLINE>
[3 rows x 2 columns]

Rename columns using a mapping:

>>> df.rename(columns={"A": "col1", "B": "col2"})
col1 col2
0 1 4
1 2 5
2 3 6
<BLANKLINE>
[3 rows x 2 columns]

Args:
columns (Mapping):
Dict-like from old column labels to new column labels.
Expand Down
13 changes: 13 additions & 0 deletions third_party/bigframes_vendored/pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,19 @@ def ndim(self) -> int:
def size(self) -> int:
"""Return an int representing the number of elements in this object.

**Examples:**

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

>>> s = bpd.Series({'a': 1, 'b': 2, 'c': 3})
>>> s.size
3

>>> df = bpd.DataFrame({'col1': [1, 2], 'col2': [3, 4]})
>>> df.size
4

Returns:
int: Return the number of rows if Series. Otherwise return the number of
rows times number of columns if DataFrame.
Expand Down
127 changes: 127 additions & 0 deletions 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 @@ -135,6 +135,35 @@ def name(self) -> Hashable:
to form a DataFrame. It is also used whenever displaying the Series
using the interpreter.

**Examples:**

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

For a Series:

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

If the Series is part of a DataFrame:

>>> df = bpd.DataFrame({'col1': [1, 2], 'col2': [3, 4]})
>>> df
col1 col2
0 1 3
1 2 4
<BLANKLINE>
[2 rows x 2 columns]
>>> s = df["col1"]
>>> s.name
'col1'

Returns:
hashable object: The name of the Series, also the column name
if part of a DataFrame.
Expand Down Expand Up @@ -560,6 +589,27 @@ def agg(self, func):
"""
Aggregate using one or more operations over the specified axis.

**Examples:**

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

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

>>> s.agg('min')
1

>>> s.agg(['min', 'max'])
min 1.0
max 4.0
dtype: Float64

Args:
func (function):
Function to use for aggregating the data.
Expand Down Expand Up @@ -2292,6 +2342,29 @@ def std(

Normalized by N-1 by default.

**Examples:**

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

>>> df = bpd.DataFrame({'person_id': [0, 1, 2, 3],
... 'age': [21, 25, 62, 43],
... 'height': [1.61, 1.87, 1.49, 2.01]}
... ).set_index('person_id')
>>> df
age height
person_id
0 21 1.61
1 25 1.87
2 62 1.49
3 43 2.01
<BLANKLINE>
[4 rows x 2 columns]

>>> df.std()
age 18.786076
height 0.237417
dtype: Float64

Returns
-------
Expand Down Expand Up @@ -2649,6 +2722,34 @@ def rename(self, index, **kwargs) -> Series | None:

Alternatively, change ``Series.name`` with a scalar value.

**Examples:**

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

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

You can changes the Series name by specifying a string scalar:

>>> s.rename("my_name")
0 1
1 2
2 3
Name: my_name, dtype: Int64

You can change the labels by specifying a mapping:

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

Args:
index (scalar, hashable sequence, dict-like or function optional):
Functions or dict-like are transformations to apply to
Expand Down Expand Up @@ -2990,3 +3091,29 @@ def values(self):

"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

@property
def size(self) -> int:
"""Return the number of elements in the underlying data.

**Examples:**

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

For Series:

>>> s = bpd.Series({'a': 1, 'b': 2, 'c': 3})
>>> s.size
3

For Index:

>>> idx = bpd.Index(bpd.Series([1, 2, 3]))
>>> idx.size
3

Returns:
int: Return the number of elements in the underlying data.
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)