docs: Fixed docstrings of datasets #603
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #603 +/- ##
==========================================
+ Coverage 96.03% 96.06% +0.02%
==========================================
Files 110 110
Lines 4265 4265
==========================================
+ Hits 4096 4097 +1
+ Misses 169 168 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
fg-mindee
added
the
topic: documentation
fg-mindee
approved these changes
Nov 10, 2021
| @@ -30,6 +30,7 @@ class DetectionDataset(AbstractDataset): | |||
| sample_transforms: composable transformations that will be applied to each image | |||
| rotated_bbox: whether polygons should be considered as rotated bounding box (instead of straight ones) | |||
| """ | |||
|
|
|||
There was a problem hiding this comment.
Curious here, why was this needed? (all style checks are passing)
| >>> img, target = train_set[0] | ||
|
|
||
| Args: | ||
| img_folder: path to the images folder | ||
| labels_path: pathe to the json file containing all labels (character sequences) | ||
| sample_transforms: composable transformations that will be applied to each image | ||
| """ | ||
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adding blank line between docstring and constructor (format)
and fix two wrong docstrings / docu