Updating documentation for vision #1999
Conversation
rabah-khalek
left a comment
rabah-khalek
left a comment
There was a problem hiding this comment.
I would remove this sentence: "The giskard-vision library is under development. For now, only landmark detection models are available."
…ing two tutorial notebooks + updating class names
rabah-khalek
left a comment
rabah-khalek
left a comment
There was a problem hiding this comment.
some comments, but overall good.
I would also remove all the docstrings (like in dataloaders for instance, since you're already explaining the methods in the guide)
| Returns: | ||
| np.ndarray: The image as numpy array (h, w, c) | ||
| """ | ||
| return self.images_paths[idx] |
There was a problem hiding this comment.
instead:
cv2.imread(str(self.images_paths[idx]))| Returns: | ||
| np.ndarray: The image as numpy array (h, w, c) | ||
| """ | ||
| return self.images_paths[idx] |
There was a problem hiding this comment.
instead:
cv2.imread(str(self.images_paths[idx]))| Returns: | ||
| np.ndarray: The image as numpy array (h, w, c) | ||
| """ | ||
| return self.images_paths[idx] |
There was a problem hiding this comment.
instead:
cv2.imread(str(self.images_paths[idx]))| def get_label(self, idx: int) -> Optional[np.ndarray]: | ||
| """ | ||
| Gets the box coordinates (for a single image) for a specific index. | ||
| Format: | ||
| np.array({"boxes": [x1_min, y1_min, x1_max, y1_max]}) | ||
| Args: | ||
| idx (int): Index of the image. | ||
| Returns: | ||
| Optional[np.ndarray]: Box coordinates for the given index. | ||
| """ | ||
| return np.array(..., dtype=object) |
There was a problem hiding this comment.
| To scan your model, start by **wrapping your dataset** with `DataIteratorBase`. Your class should override: | ||
|
|
||
| - `idx_sampler` (property) that returns the array of indices to iterate over | ||
| - `get_image` that loads the image corresponding to the right index as a `np.ndarray` |
There was a problem hiding this comment.
to be adjusted: a dict containing boxes (np.array) and labels (string) as keys
|
Description
Related Issue
Type of Change
Checklist
CODE_OF_CONDUCT.mddocument.CONTRIBUTING.mdguide.pdm.lockrunningpdm update-lock(only applicable whenpyproject.tomlhas beenmodified)