-
-
Notifications
You must be signed in to change notification settings - Fork 17.9k
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.
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
DOC: update the docstring of pandas.DataFrame.from_dict #20259
Changes from 5 commits
185ed0b
a7b4191
978d577
4f884a6
9caaadd
29beaa1
b07d9fb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -883,27 +883,66 @@ def dot(self, other): | |
@classmethod | ||
def from_dict(cls, data, orient='columns', dtype=None, columns=None): | ||
""" | ||
Construct DataFrame from dict of array-like or dicts | ||
Construct DataFrame from dict of array-like or dicts. | ||
|
||
Creates DataFrame object from dictionary by columns or by index | ||
allowing dtype specification. | ||
|
||
Parameters | ||
---------- | ||
data : dict | ||
{field : array-like} or {field : dict} | ||
Of the form {field : array-like} or {field : dict}. | ||
orient : {'columns', 'index'}, default 'columns' | ||
The "orientation" of the data. If the keys of the passed dict | ||
should be the columns of the resulting DataFrame, pass 'columns' | ||
(default). Otherwise if the keys should be rows, pass 'index'. | ||
dtype : dtype, default None | ||
Data type to force, otherwise infer | ||
columns: list, default None | ||
Column labels to use when orient='index'. Raises a ValueError | ||
if used with orient='columns' | ||
|
||
Data type to force, otherwise infer. | ||
columns : list, default None | ||
Column labels to use when ``orient='index'``. Raises a ValueError | ||
if used with ``orient='columns'``. | ||
.. versionadded:: 0.23.0 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you need to keep a blank line above it to render good in sphinx. Can you check with that again? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
Returns | ||
------- | ||
DataFrame | ||
pandas.DataFrame | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. DataFrame is ok here |
||
|
||
See Also | ||
-------- | ||
pandas.DataFrame.from_records : DataFrame from ndarray (structured dtype), | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. don't need the pandas. |
||
list of tuples, dict, or DataFrame | ||
pandas.DataFrame: DataFrame object creation using constructor | ||
|
||
Examples | ||
-------- | ||
By default the keys of the dict become the DataFrame columns: | ||
|
||
>>> data = {'col_1': [3, 2, 1, 0], 'col_2': ['a', 'b', 'c', 'd']} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you put above this example a sentence like "By default the keys of the dict become the DataFrame columns:" and then before the next example something like "Specify |
||
>>> pd.DataFrame.from_dict(data) | ||
col_1 col_2 | ||
0 3 a | ||
1 2 b | ||
2 1 c | ||
3 0 d | ||
|
||
Specify ``orient='index'`` to create the DataFrame using dictionary | ||
keys as rows: | ||
|
||
>>> data = {'row_1': [3, 2, 1, 0], 'row_2': ['a', 'b', 'c', 'd']} | ||
>>> pd.DataFrame.from_dict(data, orient='index') | ||
0 1 2 3 | ||
row_1 3 2 1 0 | ||
row_2 a b c d | ||
|
||
When using the 'index' orientation, the column names can be | ||
specified manually: | ||
|
||
>>> pd.DataFrame.from_dict(data, orient='index', | ||
... columns=['A', 'B', 'C', 'D']) | ||
A B C D | ||
row_1 3 2 1 0 | ||
row_2 a b c d | ||
""" | ||
index = None | ||
orient = orient.lower() | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extra whitespace here