zae-park / zae-engine Goto Github PK

View Code? Open in Web Editor NEW

1.0 2.0 0.0 71.39 MB

Python 100.00%

zae-engine's Introduction

zae-engine

AI 프로젝트의 quick-start를 위한 package.

zae-command

zae 명령어를 통해 아래의 기능들을 지원합니다.

zae hello : 정상 설치 확인
zae example : 예제 스크립트 파일 zae_example.py 생성
zae tree : package 내 지원하는 클래스 및 함수 프린트

framework

pytorch
tensorflow
flax

Install

PIP

pip install zae-engine 
# or
pip install git+https://github.com/zae-park/zae-engine.git

Poetry

poetry add zae-engine 
# or
poetry add git+https://github.com/zae-park/zae-engine.git

zae-engine's People

Contributors

Stargazers

Watchers

zae-engine's Issues

[Opt] Rewrite docstrings for autodoc

What's your problem? Please describe.
Content in github page is so poor

Describe the solution you'd like
Rewrite all docstrings as numpydoc for autodoc

Additional context
If numpydoc is not work, considering google style docstring or fix action workflow.

[Bug] ModuleNotFoundError: No module named 'tree_builder' when 'zae' command was called

Describe the bug
When the zae command is called, a ModuleNotFoundError is raised.

To Reproduce
Steps to reproduce the behavior:

Create and move to new dir 'test'
Install zae-engine's chore branch (latest) 'pip install git+https://github.com/zae-park/zae-engine.git#chore'
Call zae or zae hello on terminal.
See error

Expected behavior
zae hello command response with 'My name is zae-park'

Screenshots

Desktop (please complete the following information):

[Feat] SE Resnet builder

Describe the solution you'd like
add SE-ResNet builder with exists resnet builder and new 'se_injection' function

[Feat] Docs theme

Is your feature request related to a problem? Please describe.
The doc site seems not good.

Describe the solution you'd like
Apply appropriate theme.

Describe alternatives you've considered
Considering Jekyll (my site already use HUGO)

Additional context
reference 1
reference 2

[Feat] Scheduler module

Is your feature request related to a problem? Please describe.
Nope

Describe the solution you'd like
Scheduler module which satisfying below options.

warm-up
cosine annealing (controllable cycle, minimum, etc)
depends on epoch or step

Additionally, the plotting function should be provided to check learning rate scheduling.

[Bug] Trainer iterate twice when given epoch is 1

Describe the bug
Provides epoch as 1 using config.json, but trainer iterate twice.

Expected behavior
Trainer iterate only once.

Screenshots

Desktop (please complete the following information):

Version 0.1.2

[TODO] Increase test coverage

Is your feature request related to a problem? Please describe.
current test coverage (37%) is too low.

Describe the solution you'd like
the coverage rate must to be at least 60%.

Additional context
In version 0.1.5, this goal should be achieved.