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.

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

Add documentation for 'subset' and interpolation' arguments (ImageDataGenerator) #9817

Merged
merged 2 commits into from Apr 3, 2018
Merged

Add documentation for 'subset' and interpolation' arguments (ImageDataGenerator) #9817

merged 2 commits into from Apr 3, 2018

Conversation

StefanoCappellini
Copy link
Contributor

Methods flow (subset) and flow_from_directory (subset + interpolation) are currently missing it.

@@ -680,6 +680,8 @@ def flow(self, x, y=None, batch_size=32, shuffle=True, seed=None,
save_prefix: str (default: `''`). Prefix to use for filenames of saved pictures
(only relevant if `save_to_dir` is set).
save_format: one of "png", "jpeg" (only relevant if `save_to_dir` is set). Default: "png".
subset: Subset of data (`"training"` or `"validation"`) if
validation_split is set in ImageDataGenerator.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put "`" around code keywords.

@StefanoCappellini
Copy link
Contributor Author

StefanoCappellini commented Apr 2, 2018

Hi @fchollet , I have updated the style of the doc lines I added.
However, I think an additional and specific guide should be added to the CONTRIBUTING.md file because actually the doc style is not uniform:

A simple example of this issue is that the lines I added were simply copy and pasted from the ones found in the DirectoryIteratorclass. So now the added lines are not consistent with the old ones.

I would prefer not to change the whole doc style in this commit in order to keep its goal meaningful and compact. Please let me know if you agree.
I could open an issue on this.

@fchollet
Copy link
Member

fchollet commented Apr 3, 2018

In general all code keywords should be between backquotes. The only exception would potentially be string values, where it matters less, but even in this case backquotes are still better.

Copy link
Member

@fchollet fchollet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fchollet fchollet merged commit ef13db0 into keras-team:master Apr 3, 2018
@StefanoCappellini StefanoCappellini deleted the image-doc branch April 3, 2018 15:22
dschwertfeger added a commit to dschwertfeger/keras that referenced this pull request Apr 6, 2018
…ack-embeddings-from-layer-outputs

* upstream/master: (68 commits)
  fit/evaluate_generator supporting native tensors (keras-team#9816)
  keras-team#9642 Add kwarg and documentation for dilation_rate to SeparableConvs (keras-team#9844)
  Document that "same" is inconsistent across backends with strides!=1 (keras-team#9629)
  Improve tests by designating dtype of sample data (keras-team#9834)
  Add documentation for 'subset' and interpolation' arguments (ImageDataGenerator) (keras-team#9817)
  Revert default theme to readthedocs
  Various docs fixes.
  Fix conflict
  Add support for class methods documentation (keras-team#9751)
  Add missing verbose opt for evaluate_generator (keras-team#9811)
  Added `data_format` to flatten layer. (keras-team#9696)
  Allow saving models directly to binary stream (keras-team#9789)
  Fix ctc_batch_cost() error when batch_size = 1 (keras-team#9775)
  Fix keras-team#9802 (keras-team#9803)
  Fix error in ImageDataGenerator documentation (keras-team#9798)
  fix typo (keras-team#9792)
  keras-team#9733: Extend RemoteMonitor to send data as application/json (keras-team#9734)
  Fixed inconsistencies regarding ReduceLROnPlateau (keras-team#9723)
  Fix doc issue.
  General stateful metrics fixes (keras-team#9446)
  ...
Vijayabhaskar96 pushed a commit to Vijayabhaskar96/keras that referenced this pull request May 3, 2018
…aGenerator) (keras-team#9817)

* Add documentation for 'subset' argument (flow and flow_from_directory) and for 'interpolation' argument (flow_from_directory)

* Fix style for 'flow' and 'flow_from_directory' ImageDataGenerator methods doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants