Shapeworks: Упаковка shapworkspy и реструктуризация сценариев использования

С № 818

Измените дизайн утилит очистки, чтобы их можно было запускать интерактивно, а не пакетно.
Это избавит от необходимости сохранять промежуточные файлы ухода (проблема № 598), а шаги можно будет пропустить (проблема № 507).

Давайте использовать эту проблему как родительскую / ведущую для упаковки python shapeworks и связанного с ней варианта использования. Позже мы сможем добавить более конкретные вопросы и связать их с этой. Соответственно, я закрыл связанные вопросы.

@ jadie1 @ iyerkrithika21 присоединитесь к слоту GC, чтобы обсудить это как часть API-интерфейсов python. Этот вопрос перемещен в повестку дня, чтобы при необходимости вы могли уйти раньше.

Сейчас я изучаю упаковку модуля Python. Пожалуйста, свяжитесь со мной, если у вас есть предложения или мысли.

Некоторые инструкции, которые я нашел:

• пип: https://python-packaging-tutorial.readthedocs.io/en/latest/setup_py.html
• ... и: https://packaging.python.org/tutorials/packaging-projects/
• conda: https://python-packaging-tutorial.readthedocs.io/en/latest/conda.html
• колеса: https://realpython.com/python-wheels/

Пока меня больше всего интересует conda для, по общему мнению, лучшей спецификации зависимостей, но я был бы рад получить что-нибудь.
Причина использования conda в том, что с помощью этого пакета мы должны иметь возможность установить все: командную строку, модуль python и студию. Но мы начнем с нашего модуля python.

Мой самый большой страх - это проблемы с мультиплатформенностью, уносящие нашу жизнь, поэтому я постараюсь сначала заставить OSX работать, а потом продолжу.

Варианты использования в Ubuntu 18.04 у меня не работали, мне пришлось:

1. в RunUseCase.py я добавил вверху sys.path.append('../../build/cmake-build-release/bin/')
2. установите переменную окружения LD_LIBRARY_PATH=../../dependencies/install/lib/ (иначе он жалуется на отсутствие "libvcl.so")

Чтобы иметь возможность сохранять промежуточные выходные данные, можем ли мы включить параметр записи в каждую операцию, а не отдельную функцию записи / сохранения?
Я представляю себе следующее:

img.binarize(write=False)
img.resample(write=True).binarize(write=True)

Вместо того

img.binarize()
img.write()
img.resample()
img.write()

Вероятно, для этого потребуется имя файла в качестве входного аргумента.
например, img.binarize (write = True, filename = 'blabla')

@archanasri @cchriste мысли?

Чтобы иметь возможность сохранять промежуточные выходные данные, можем ли мы включить параметр записи в каждую операцию, а не отдельную функцию записи / сохранения?
Я представляю себе следующее:

img.binarize(write=False)
img.resample(write=True).binarize(write=True)

Вместо того

img.binarize()
img.write()
img.resample()
img.write()

Image.write объединяется в цепочку, как и все остальное. Просто положите его в цепочку, если
ты хочешь это.

img.binarize().write(<path>)
img.resample().write(<path>).binarize()

Во вторник, 19 января 2021 г., в 16:58 Ширин Эльхабиан [email protected]
написал:

Вероятно, для этого потребуется имя файла в качестве входного аргумента.
например, img.binarize (write = True, filename = 'blabla')

@archanasri https://github.com/archanasri @cchriste
https://github.com/cchriste мысли?

Чтобы иметь возможность сохранять промежуточные результаты, можем ли мы включить
возможность записи в каждой операции, а не отдельная запись / сохранение
функция?
Я представляю себе следующее:

img.binarize (write = False)
img.resample (write = True) .binarize (write = True)

Вместо того

img.binarize ()
img.write ()
img.resample ()
img.write ()

-
Вы получаете это, потому что вас упомянули.
Ответьте на это письмо напрямую, просмотрите его на GitHub
https://github.com/SCIInstitute/ShapeWorks/issues/865#issuecomment-763221837 ,
или отказаться от подписки
https://github.com/notifications/unsubscribe-auth/AAJT3EP3HDOHQGC54NMWSJDS2YMA7ANCNFSM4U3KV45Q
.

Image.write объединяется в цепочку, как и все остальное. Просто положите его в цепочку, если хотите. img.binarize().write(<path>) img.resample().write(<path>).binarize()
…

Я понимаю, что функция записи также имеет цепочку; Моя точка зрения с предложением опции записи в каждой операции заключалась в том, чтобы иметь только одну функцию и передавать флаг, хотим ли мы сохранить промежуточные изображения или нет, и упростить варианты использования.
Пример sudo-кода:

function groom(write_flag):
    img.binarize(write = write_flag).resize(write = write_flag).crop(write=write_flag)
groom(write_flag = True)
groom(write_flag = False)

Таким образом, мы можем избежать повторения одного и того же фрагмента кода. Просто хочу узнать осуществимость этой идеи.

Одна из причин, по которой мы пытаемся демонтировать набор GroomUtils.py
«Вспомогательные» функции - сделать наши операции по уходу более прозрачными.
Без упаковки этих операций в монолитные функции, сделанных гибкими
только путем передачи параметров гораздо проще создавать простые,
понятные демонстрации вариантов использования. Если мы не будем использовать (много) цепочек в
в наших примерах будет очень просто передать умение писать
промежуточные результаты, когда это будет сочтено необходимым. Прямо сейчас они все кажутся
необходимо, потому что у нас есть варианты использования, которые требуют этих результатов, так как
одна функция GroomUtils выполняет некоторый (возможно, произвольный) набор
операций, сохраняет результат, затем следующая функция считывает эти результаты
и продолжает обработку.

Я предлагаю для начала все сгладить, и для всех случаев использования не
просто эллипсоиды. Я считаю, что то, что мы увидим, относительно
простой набор операций, который заметно различается для определенных случаев
(например, когда исходные изображения «готовы к поездке»). Что будут делать пользователи
получить из наших примеров гораздо более четкое понимание того, что может и / или
следует делать для собственных наборов данных.

Вот пример того, что я хотел бы подражать, если бы я был пользователем:

for img in images:

# since we're starting with fuzzy data, we first need to ensure it's a
binary (black and white) image in order to <explain>
img.binarize()

# next, we must ensure images all have the same logical dimensions since
<explain>
img.resize()

# now we'll crop these images using the bounds we computed earlier so they
all encompass the data without leftover space (since it can be costly and
pointless to compute)
img.crop(bounds)

Мы можем предоставить примеры цепочки записи для любой из этих операций, например
например, добавив .write(<path> после одного из них. Чего мы не хотим, так это некоторых
функция, которая "просто делает это", поскольку "это" не одно и то же для всех
набор данных. Вместо,
мы дадим пользователям возможность, показывая им, что то, что делается, - это еще не все
это сложно и очень легко изменить. Вместо того, чтобы дать им
интерфейс черного ящика с миллионом параметров, дайте им ключи и позвольте
их водят. Надеюсь, это поможет прояснить всю идею избавления
из GroomUtils.

В понедельник, 25 января 2021 г., в 9:49, Критика Айер [email protected]
написал:

Image.write объединяется в цепочку, как и все остальное. Просто положите его в цепочку, если
ты хочешь это. img.binarize (). write ()
img.resample (). write () .binarize ()
… <# M_-7433729883366947300_>

Я понимаю, что функция записи также имеет цепочку; моя точка зрения с
предлагая вариант записи в каждой операции, нужно было иметь только один
функция и передаем флаг, хотим ли мы сохранить промежуточные изображения
или нет и упростите варианты использования.
Пример sudo-кода:

функция groom (write_flag):

img.binarize(write = write_flag).resize(write = write_flag).crop(write=write_flag)

жених (write_flag = True)

жених (write_flag = False)

Таким образом, мы можем избежать повторения одного и того же фрагмента кода.

-
Вы получаете это, потому что вас упомянули.
Ответьте на это письмо напрямую, просмотрите его на GitHub
https://github.com/SCIInstitute/ShapeWorks/issues/865#issuecomment-766952032 ,
или отказаться от подписки
https://github.com/notifications/unsubscribe-auth/AAJT3EJND2F3EDVU75NB6ITS3WOIPANCNFSM4U3KV45Q
.

@ iyerkrithika21 @ jadie1

Я согласен с @cchriste. Давайте не будем использовать цепочку, если она не является семантически разумной (например, передискретизация двоичных изображений), даже в этих случаях нам не нужно записывать каждый промежуточный вывод этого шага передискретизации (комбо). Давайте сделаем сценарии использования простыми для понимания, самодокументированными и удобными для пользователей, чтобы их можно было адаптировать и настраивать.

Написание (особенно временно для отладки) изображений - отличный пример
когда цепочка разумна.

# let's see what happened
img.operation(...) -> img.operation(...).write(<path>)

Принимая во внимание, что, когда это важный шаг, может быть лучше поставить его на
собственная строка с комментарием.

...
# now let's write the results
img.write(<path>)

В пн, 25 января 2021 г., в 10:34 Ширин Эльхабиан [email protected]
написал:

@ iyerkrithika21 https://github.com/iyerkrithika21 @ jadie1
https://github.com/jadie1

Я согласен с @cchriste https://github.com/cchriste . Не будем использовать
цепочки, если это не является семантически разумным (например, повторная выборка
двоичные изображения), даже в этих случаях нам не нужно писать каждые
промежуточный результат этого шага передискретизации (комбо). Приведем примеры использования
простой для понимания, самодокументированный и простой для пользователей в адаптации и настройке.

-
Вы получаете это, потому что вас упомянули.
Ответьте на это письмо напрямую, просмотрите его на GitHub
https://github.com/SCIInstitute/ShapeWorks/issues/865#issuecomment-766983878 ,
или отказаться от подписки
https://github.com/notifications/unsubscribe-auth/AAJT3EKKARLKY4VKBRPHJWLS3WTSNANCNFSM4U3KV45Q
.

Этапы реструктуризации:

1. Включите все вспомогательные функции, используемые в записных книжках Jupyter, в модуль Python ShapeWorks.
2. Обновите записные книжки, чтобы использовать вспомогательные функции из модуля python.
3. Перепишите варианты использования Python с помощью модуля Python и команд API Python без использования GroomUtils.

Помните, у нас есть ветка python_module, в которой это уже запущено. Он не был объединен ни минуты, но держите нас в курсе, если кто-то с этим справится. Это в моем списке приоритетов.