search

uber / petastorm

Petastorm library enables single machine or distributed training and evaluation of deep learning models from datasets in Apache Parquet format. It supports ML frameworks such as Tensorflow, Pytorch, and PySpark and can be used from pure Python code.
Apache License 2.0
1.8k stars 284 forks source link

Fixed docstring in NGram class: timestamp_field argument illustration… #628

Closed ritwikbera closed 3 years ago

ritwikbera commented 3 years ago

The usage examples shown in the docstring of the NGram class have an error. Entering the timestamp parameter as a string (i.e. 'id') doesn't work. It should be a Unischema Field. (i.e. entered as TestSchema.id). This pull request reflects the necessary change in the docstring.

CLAassistant commented 3 years ago

CLA assistant check
All committers have signed the CLA.

codecov[bot] commented 3 years ago

Codecov Report

Merging #628 (13f6bd1) into master (138ad6d) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #628   +/-   ##
=======================================
  Coverage   85.32%   85.32%           
=======================================
  Files          85       85           
  Lines        4933     4933           
  Branches      783      783           
=======================================
  Hits         4209     4209           
  Misses        584      584           
  Partials      140      140
Impacted Files Coverage Δ
petastorm/ngram.py 87.23% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 138ad6d...13f6bd1. Read the comment docs.