-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
fix: clarify py_modules usage in 1546 #1597
Merged
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ca11486
fix: clarify py_modules usage in 1549
hanxiao d3ad0a8
fix: clarify py_modules usage in 1549
hanxiao 4e95946
fix: clarify py_modules usage in 1549
hanxiao 4c6ad72
fix: clarify py_modules usage in 1546
hanxiao 0523319
docs: fix doc link of logo
hanxiao 3a2da3a
fix: clarify py_modules usage in 1546
hanxiao File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Empty file.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
!CustomCrafter1 | ||
metas: | ||
py_modules: custom_crafter.py # I also tried to add helper.py here |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
from jina.executors.crafters import BaseSegmenter | ||
from .helper import helper_function | ||
|
||
|
||
class CustomCrafter1(BaseSegmenter): | ||
def __init__(self, *args, **kwargs): | ||
super().__init__(*args, **kwargs) | ||
print(helper_function) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
def helper_function(): | ||
pass |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
from .helper import helper_function | ||
|
||
from jina.executors.crafters import BaseSegmenter | ||
|
||
|
||
class CustomCrafter2(BaseSegmenter): | ||
def __init__(self, *args, **kwargs): | ||
super().__init__(*args, **kwargs) | ||
print(helper_function) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
!CustomCrafter2 | ||
metas: | ||
py_modules: | ||
- __init__.py | ||
- helper.py |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
def helper_function(): | ||
pass |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
!CustomCrafter3 | ||
metas: | ||
py_modules: | ||
- helper.py | ||
- custom_crafter.py |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
from jinahub.helper import helper_function | ||
|
||
from jina.executors.crafters import BaseSegmenter | ||
|
||
|
||
class CustomCrafter3(BaseSegmenter): | ||
def __init__(self, *args, **kwargs): | ||
super().__init__(*args, **kwargs) | ||
print(helper_function) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
def helper_function(): | ||
pass |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
from .helper import helper_function | ||
|
||
from jina.executors.crafters import BaseSegmenter | ||
|
||
|
||
class CustomCrafter4(BaseSegmenter): | ||
def __init__(self, *args, **kwargs): | ||
super().__init__(*args, **kwargs) | ||
print(helper_function) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
!CustomCrafter4 | ||
metas: | ||
py_modules: | ||
- helper.py | ||
- __init__.py |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
def helper_function(): | ||
pass |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
from typing import Tuple, Dict, List, Union | ||
|
||
import numpy as np | ||
from jina.executors.crafters import BaseSegmenter | ||
|
||
from .helper import _crop_image, _move_channel_axis, _load_image | ||
|
||
|
||
class FiveImageCropper2(BaseSegmenter): | ||
""" | ||
:class:`FiveImageCropper` crops the image into four corners and the central crop. | ||
""" | ||
|
||
def __init__(self, | ||
target_size: Union[Tuple[int, int], int] = 224, | ||
channel_axis: int = -1, | ||
*args, | ||
**kwargs): | ||
""" | ||
|
||
:param target_size: desired output size. If size is a sequence like (h, w), the output size will be matched to | ||
this. If size is an int, the output will have the same height and width as the `target_size`. | ||
""" | ||
super().__init__(*args, **kwargs) | ||
self.target_size = target_size | ||
self.channel_axis = channel_axis | ||
|
||
def craft(self, blob: 'np.ndarray', *args, **kwargs) -> List[Dict]: | ||
""" | ||
Crop the input image array. | ||
|
||
:param blob: the ndarray of the image with the color channel at the last axis | ||
:return: a list of five chunk dicts with the cropped images | ||
""" | ||
raw_img = _load_image(blob, self.channel_axis) | ||
image_width, image_height = raw_img.size | ||
if isinstance(self.target_size, int): | ||
target_h = target_w = self.target_size | ||
elif isinstance(self.target_size, Tuple) and len(self.target_size) == 2: | ||
target_h, target_w = self.target_size | ||
else: | ||
raise ValueError(f'target_size should be an integer or a tuple of two integers: {self.target_size}') | ||
_tl, top_tl, left_tl = _crop_image(raw_img, self.target_size, 0, 0) | ||
tl = _move_channel_axis(np.asarray(_tl), -1, self.channel_axis) | ||
_tr, top_tr, left_tr = _crop_image(raw_img, self.target_size, top=0, left=image_width - target_w) | ||
tr = _move_channel_axis(np.asarray(_tr), -1, self.channel_axis) | ||
_bl, top_bl, left_bl = _crop_image(raw_img, self.target_size, top=image_height - target_h, left=0) | ||
bl = _move_channel_axis(np.asarray(_bl), -1, self.channel_axis) | ||
_br, top_br, left_br = _crop_image(raw_img, self.target_size, top=image_height - target_h, | ||
left=image_width - target_w) | ||
br = _move_channel_axis(np.asarray(_br), -1, self.channel_axis) | ||
_center, top_center, left_center = _crop_image(raw_img, self.target_size, how='center') | ||
center = _move_channel_axis(np.asarray(_center), -1, self.channel_axis) | ||
return [ | ||
dict(offset=0, weight=1., blob=tl.astype('float32'), location=(top_tl, left_tl)), | ||
dict(offset=0, weight=1., blob=tr.astype('float32'), location=(top_tr, left_tr)), | ||
dict(offset=0, weight=1., blob=bl.astype('float32'), location=(top_bl, left_bl)), | ||
dict(offset=0, weight=1., blob=br.astype('float32'), location=(top_br, left_br)), | ||
dict(offset=0, weight=1., blob=center.astype('float32'), location=(top_center, left_center)), | ||
] |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
!FiveImageCropper2 | ||
with: | ||
{} | ||
metas: | ||
py_modules: | ||
# - you can put more dependencies here | ||
- helper.py | ||
- __init__.py |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
__copyright__ = "Copyright (c) 2020 Jina AI Limited. All rights reserved." | ||
__license__ = "Apache-2.0" | ||
|
||
from typing import Tuple, Union | ||
|
||
import numpy as np | ||
|
||
|
||
def _move_channel_axis(img: 'np.ndarray', channel_axis_to_move: int, target_channel_axis: int = -1) -> 'np.ndarray': | ||
""" | ||
Ensure the color channel axis is the default axis. | ||
""" | ||
if channel_axis_to_move == target_channel_axis: | ||
return img | ||
return np.moveaxis(img, channel_axis_to_move, target_channel_axis) | ||
|
||
|
||
def _load_image(blob: 'np.ndarray', channel_axis: int): | ||
""" | ||
Load an image array and return a `PIL.Image` object. | ||
""" | ||
|
||
from PIL import Image | ||
img = _move_channel_axis(blob, channel_axis) | ||
return Image.fromarray(img.astype('uint8')) | ||
|
||
|
||
def _crop_image(img, target_size: Union[Tuple[int, int], int], top: int = None, left: int = None, how: str = 'precise'): | ||
""" | ||
Crop the input :py:mod:`PIL` image. | ||
|
||
:param img: :py:mod:`PIL.Image`, the image to be resized | ||
:param target_size: desired output size. If size is a sequence like | ||
(h, w), the output size will be matched to this. If size is an int, | ||
the output will have the same height and width as the `target_size`. | ||
:param top: the vertical coordinate of the top left corner of the crop box. | ||
:param left: the horizontal coordinate of the top left corner of the crop box. | ||
:param how: the way of cropping. Valid values include `center`, `random`, and, `precise`. Default is `precise`. | ||
- `center`: crop the center part of the image | ||
- `random`: crop a random part of the image | ||
- `precise`: crop the part of the image specified by the crop box with the given ``top`` and ``left``. | ||
.. warning:: When `precise` is used, ``top`` and ``left`` must be fed valid value. | ||
|
||
""" | ||
import PIL.Image as Image | ||
assert isinstance(img, Image.Image), 'img must be a PIL.Image' | ||
img_w, img_h = img.size | ||
if isinstance(target_size, int): | ||
target_h = target_w = target_size | ||
elif isinstance(target_size, Tuple) and len(target_size) == 2: | ||
target_h, target_w = target_size | ||
else: | ||
raise ValueError(f'target_size should be an integer or a tuple of two integers: {target_size}') | ||
w_beg = left | ||
h_beg = top | ||
if how == 'center': | ||
w_beg = int((img_w - target_w) / 2) | ||
h_beg = int((img_h - target_h) / 2) | ||
elif how == 'random': | ||
w_beg = np.random.randint(0, img_w - target_w + 1) | ||
h_beg = np.random.randint(0, img_h - target_h + 1) | ||
elif how == 'precise': | ||
assert (w_beg is not None and h_beg is not None) | ||
assert (0 <= w_beg <= (img_w - target_w)), f'left must be within [0, {img_w - target_w}]: {w_beg}' | ||
assert (0 <= h_beg <= (img_h - target_h)), f'top must be within [0, {img_h - target_h}]: {h_beg}' | ||
else: | ||
raise ValueError(f'unknown input how: {how}') | ||
if not isinstance(w_beg, int): | ||
raise ValueError(f'left must be int number between 0 and {img_w}: {left}') | ||
if not isinstance(h_beg, int): | ||
raise ValueError(f'top must be int number between 0 and {img_h}: {top}') | ||
w_end = w_beg + target_w | ||
h_end = h_beg + target_h | ||
img = img.crop((w_beg, h_beg, w_end, h_end)) | ||
return img, h_beg, w_beg | ||
|
||
|
||
def _resize_short(img, target_size: Union[Tuple[int, int], int], how: str = 'LANCZOS'): | ||
""" | ||
Resize the input :py:mod:`PIL` image. | ||
:param img: :py:mod:`PIL.Image`, the image to be resized | ||
:param target_size: desired output size. If size is a sequence like (h, w), the output size will be matched to | ||
this. If size is an int, the smaller edge of the image will be matched to this number maintain the aspect | ||
ratio. | ||
:param how: the interpolation method. Valid values include `NEAREST`, `BILINEAR`, `BICUBIC`, and `LANCZOS`. | ||
Default is `LANCZOS`. Please refer to `PIL.Image` for detaisl. | ||
""" | ||
import PIL.Image as Image | ||
assert isinstance(img, Image.Image), 'img must be a PIL.Image' | ||
if isinstance(target_size, int): | ||
percent = float(target_size) / min(img.size[0], img.size[1]) | ||
target_w = int(round(img.size[0] * percent)) | ||
target_h = int(round(img.size[1] * percent)) | ||
elif isinstance(target_size, Tuple) and len(target_size) == 2: | ||
target_h, target_w = target_size | ||
else: | ||
raise ValueError(f'target_size should be an integer or a tuple of two integers: {target_size}') | ||
img = img.resize((target_w, target_h), getattr(Image, how)) | ||
return img |
85 changes: 85 additions & 0 deletions
85
tests/integration/issues/github_1546/test_pymodules_import.py
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
import pytest | ||
|
||
from jina.executors import BaseExecutor | ||
|
||
|
||
def test_import_with_abs_namespace_should_pass(): | ||
""" | ||
This is a valid structure: | ||
- "my_cust_module" is not a python module (lack of __init__.py under the root) | ||
- to import ``foo.py``, you must to use ``from jinahub.foo import bar`` | ||
- ``jinahub`` is a common namespace for all plugin-modules, not changeable. | ||
- ``helper.py`` needs to be put BEFORE `my_cust.py` in YAML ``py_modules`` | ||
|
||
File structure: | ||
|
||
my_cust_module | ||
|- my_cust.py | ||
|- helper.py | ||
|- config.yml | ||
|- py_modules | ||
|- helper.py | ||
|- my_cust.py | ||
""" | ||
|
||
b = BaseExecutor.load_config('good1/crafter.yml') | ||
assert b.__class__.__name__ == 'CustomCrafter3' | ||
|
||
|
||
def test_import_with_module_structure_should_pass(): | ||
""" | ||
This is a valid structure and it is RECOMMENDED: | ||
- "my_cust_module" is a python module | ||
- all core logic of your customized executor goes to ``__init__.py`` | ||
- to import ``foo.py``, you can use relative import, e.g. ``from .foo import bar`` | ||
- ``helper.py`` needs to be put BEFORE `__init__.py` in YAML ``py_modules`` | ||
|
||
This is also the structure given by ``jina hub new`` CLI. | ||
|
||
File structure: | ||
|
||
my_cust_module | ||
|- __init__.py | ||
|- helper.py | ||
|- config.yml | ||
|- py_modules | ||
|- helper.py | ||
|- __init__.py | ||
""" | ||
b = BaseExecutor.load_config('good2/crafter.yml') | ||
assert b.__class__.__name__ == 'CustomCrafter4' | ||
|
||
|
||
def test_import_with_hub_structure_should_pass(): | ||
""" | ||
copy paste from hub module structure should work | ||
this structure is copy-paste from: https://github.com/jina-ai/jina-hub/tree/master/crafters/image/FiveImageCropper | ||
|
||
File structure: | ||
my_cust_modul | ||
| | ||
|- __init__.py | ||
|- helper.py | ||
|- config.yml | ||
|- py_modules | ||
|- helper.py | ||
|- __init.py | ||
:return: | ||
""" | ||
b = BaseExecutor.load_config('good3/config.yml') | ||
assert b.__class__.__name__ == 'FiveImageCropper2' | ||
|
||
|
||
def test_import_casual_structure_should_fail(): | ||
# this structure is a copy-paste from | ||
# https://github.com/jina-ai/jina/issues/1546#issuecomment-751481422 | ||
with pytest.raises(ImportError): | ||
BaseExecutor.load_config('bad1/crafter.yml') | ||
|
||
|
||
def test_import_good_structure_but_wrong_import_order_should_fail(): | ||
# this structure is a copy paste of "test_import_with_module_structure_should_pass" but with wrong import order | ||
# if A depends on B, i.e. in A.py you write "import B" | ||
# then B.py should be put in front of A.py in py_modules, otherwise it will fail | ||
with pytest.raises(ImportError): | ||
BaseExecutor.load_config('bad2/crafter.yml') |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this may put some problems in many hub executors right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no, irrelevant, magic is in
spec.loader.exec_module(module)