Skip to content
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.

Sign up for GitHub

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

Refactored and integrated Grey Wolf Optimizer #121

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

Refactored and integrated Grey Wolf Optimizer #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
7a6fd5c
feat(ngen_cal): create initial optimizers subpackage
hellkite500 Apr 30, 2024
92abc92
feat(ngen_cal): initial grew wolf optimizer implementation
xfeng2021 Apr 30, 2024
aea9508
test: add initial test of grey wolf optimizer
hellkite500 Apr 30, 2024
2dde645
test: test grew wolf optimize function
hellkite500 Apr 30, 2024
79f25e0
test: test grew wolf restart from iteration
hellkite500 Apr 30, 2024
1d6dad4
fix(grey_wolf): fix original implementation to pass restart test
hellkite500 Apr 30, 2024
e52b78f
refactor(grey_wolf): refactor and condense grew wolf implementation
hellkite500 Apr 30, 2024
98d23e3
feat: expose GrewWolfOptimizer from optimizers subpackage
hellkite500 Apr 30, 2024
7cccd3a
test: update grew wolf test for refactored optmizer
hellkite500 Apr 30, 2024
20d716b
doc: v0.3 changelog draft, setup dependencies updated
hellkite500 Apr 30, 2024
9e98022
refactor: add private `_optimizers` subpackage; move gwo there; expor…
aaraney May 2, 2024
f964aba
chore: remove erroneous __all__
aaraney May 2, 2024
b567b53
style: sort imports
aaraney May 2, 2024
3c9f431
chore: add type hints and improve signatures
aaraney May 2, 2024
8d03bc4
refactor: use ctx manager; move code to .
aaraney May 2, 2024
3ee74f6
chore: add return type hint
aaraney May 2, 2024
1dca37d
chore: improve doc type hints
aaraney May 2, 2024
a12cd96
style: use google style doc strings
aaraney May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions python/ngen_cal/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# V 0.3.X
- `ngen.cal` subpackage for `optmizers`
- `ngen.cal.optmizers` Grey Wolf Optimizer added

# V 0.2.1
- `ngen.cal` `Objective` enum now properly subclasses `str`. This fixes
pydantic models' json schemas that use `Objective` as a field type. See #31
Expand Down
1 change: 1 addition & 0 deletions python/ngen_cal/setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ install_requires =
hydrotools.metrics
hydrotools.nwis_client
pyarrow
pyswarms
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have to do this here, but we should move deps like pyswarms to an [options.extras_require]. This would let people install ngen.cal[particalswarm] for example. So, just pull in what you need.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add pyswarms to requirements.txt?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah? I am inclined to remove the root repo requirements.txt in favor of a ns package level requirements.txt instead. In either case, we should use pip freeze to generate requirements.txt instead of just listing out all the deps.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets open this as a TODO in an issue and cycle back to this.

tables
hypy @ git+https://github.com/noaa-owp/hypy@master#egg=hypy&subdirectory=python
ngen_config @ git+https://github.com/noaa-owp/ngen-cal@master#egg=ngen_config&subdirectory=python/ngen_conf
Expand Down
Empty file added python/ngen_cal/src/ngen/cal/_optimizers/__init__.py
View file
Open in desktop
Empty file.
Loading
Loading