pcoet commented on a change in pull request #14382:
URL: https://github.com/apache/beam/pull/14382#discussion_r610300583
##########
File path: sdks/python/apache_beam/dataframe/frame_base.py
##########
@@ -356,6 +374,85 @@ def wrapper(*args, **kwargs):
return wrap
+BEAM_SPECIFIC = "Differences from pandas"
+
+SECTION_ORDER = [
+ 'Parameters',
+ 'Returns',
+ 'Raises',
+ BEAM_SPECIFIC,
+ 'See Also',
+ 'Notes',
+ 'Examples'
+]
+
+EXAMPLES_DISCLAIMER = (
+ "**NOTE:** These examples are pulled directly from the pandas
documentation "
+ "for convenience. The Beam DataFrame API will look different because it is
"
Review comment:
"The Beam DataFrame API" -> "Usage of the Beam DataFrame API"
##########
File path: sdks/python/apache_beam/dataframe/frames.py
##########
@@ -1215,17 +1267,22 @@ def aggregate(self, func, axis=0, *args, **kwargs):
agg = aggregate
- applymap = frame_base._elementwise_method('applymap')
+ applymap = frame_base._elementwise_method('applymap', base=pd.DataFrame)
memory_usage = frame_base.wont_implement_method('non-deferred value')
info = frame_base.wont_implement_method('non-deferred value')
clip = frame_base._elementwise_method(
- 'clip', restrictions={'axis': lambda axis: axis in (0, 'index')})
+ 'clip', restrictions={'axis': lambda axis: axis in (0, 'index')},
base=pd.DataFrame)
+ @frame_base.with_docs_from(pd.DataFrame)
@frame_base.args_to_kwargs(pd.DataFrame)
@frame_base.populate_defaults(pd.DataFrame)
def corr(self, method, min_periods):
+ """Only ``method="pearson"`` can be parallelized, other methods require
Review comment:
"parallelized, other" -> "parallelized. Other"
##########
File path: sdks/python/apache_beam/dataframe/__init__.py
##########
@@ -14,4 +14,17 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+"""Beam DataFrame API
+
+- For high-level documentation see
+ https://beam.apache.org/documentation/dsls/dataframes/overview/
+- :mod:`apache_beam.dataframe.io`: DataFrame I/Os
+- :mod:`apache_beam.dataframe.frames`: DataFrame operations
+- :mod:`apache_beam.dataframe.convert`: Conversion between
+ :class:`~apache_beam.pvalue.PCollection` and
+ :class:`~apache_beam.dataframe.frames.DeferredDataFrame`.
+- :mod:`apache_beam.dataframe.transforms`: Embed DataFrame operations in a
+ Beam pipeline.
Review comment:
"Embed DataFrame operations in a Beam pipeline." -> "DataFrame
operations for use in a Beam pipeline."
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
