-
Notifications
You must be signed in to change notification settings - Fork 23
[WIP]rewrite workflow implementation. Add prefect framework. prepare for paper. #89
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
Closed
Closed
Changes from 32 commits
Commits
Show all changes
345 commits
Select commit
Hold shift + click to select a range
024372e
Merge branch 'deepmodeling:master' into master
felix5572 f06e4f9
fix bug in docs display
felix5572 71b0996
update docs
felix5572 ad80c18
Merge pull request #4 from felix5572/master
amcadmus efb36b7
modify gdi.py
felix5572 b7130de
update dpti gdi airflow
felix5572 fef222f
update airflow-workflow
felix5572 7c0a5d5
update dpti
felix5572 cfa7d71
update gdi workflow
felix5572 eb846f2
fix bug in gdi workflow
felix5572 b8420ae
fix unittest
felix5572 5a9263d
update gdi
felix5572 7ec9cf7
update gdi -airflow
felix5572 e057cc5
update gdi
felix5572 f7cf1df
update gdi
felix5572 45cbec7
update gdi.py
felix5572 9b31c27
update gdi workflow
felix5572 b5aa53b
update gdi.py
felix5572 1bbed62
update gdi.py for airflow
felix5572 5075455
will not print debug information
felix5572 066cc50
Merge remote-tracking branch 'origin/master'
felix5572 3e1aabc
reset changes of format
felix5572 ab7583d
clear more debug print
felix5572 9693f59
update gdi.py for dargs
felix5572 86e167d
update setup.py for dargs
felix5572 6384958
update gdi.py for dargs
felix5572 6fd1225
update airflow-gdi; use separate airflow-graph's node for MD tasks
felix5572 fa9384d
update for airflow gdi.py; use two seperate node to run MD simulations
felix5572 f2c2d92
change tasks to task_list; add airflow retries
felix5572 4ad0c62
fix bug of task_list
felix5572 ca64639
gdi.py airflow main will fail when sub dag fail
felix5572 afbd308
Merge pull request #5 from felix5572/master
amcadmus bc75ba3
Create LICENSE
njzjz 78cfc8f
Merge pull request #6 from njzjz/patch-1
amcadmus 9f44d6b
better print informaiton for hti
felix5572 02bd08b
support set pv and pv_err value manually for hti_ice.py
felix5572 e6e9f5d
support set pv and pv_err value manually for hti_water.py
felix5572 a72843b
clean dpti ti.py numberial integration not used now
felix5572 1882b85
fix module import
felix5572 846a89b
update field for hti_water.py
felix5572 42854a5
add funciton exec_args for function execution; convenient for unittest
felix5572 8d6aecc
Merge remote-tracking branch 'origin/master'
felix5572 65ee5e8
use with open
felix5572 e7b0671
add unittest for hti_ice.py and hti_water.py
felix5572 292f8a9
fix unittest
felix5572 8a2ff8c
update ti.py; change thermo result type from list to np.ndarray
felix5572 443e670
Merge remote-tracking branch 'origin/master'
felix5572 d34d16a
better ti.py output
felix5572 c055420
update gdi.py to support new dpdispatcher
felix5572 2718508
fix bug when reading files
felix5572 bee7c83
update ti.py dump json format
felix5572 1162ccb
update ti_water.py json dump
felix5572 2318c09
update field in hti.py compatible with old
felix5572 99ed3dc
update equi.py args check
felix5572 61bd829
add function create_dict_not_empty_key and get_first_matched_key_from…
felix5572 9e4b5a3
clean duplicated field in benchmark_equi/npt/jdata.json
felix5572 29d7b7a
update git ignore
felix5572 7467a85
update compatibility; support old fields
felix5572 fde752d
update setup.py fix install
felix5572 251ae3a
update to support fields in old json relating to water
felix5572 cc465b0
support old jsons relating to water
felix5572 55a2c29
support old json format relating to water
felix5572 221445d
update field is_water
felix5572 2a7b0e1
update variable name in ti.py
felix5572 edee593
compatible with old ti json file
felix5572 fd73f12
update field compatible with old ti json field
felix5572 ae3434c
add default value for key if_meam
felix5572 94fce85
Merge remote-tracking branch 'origin/master'
felix5572 7808bd8
update ti_water.py for better unittest
felix5572 3341a14
fix bug; will add element_num
felix5572 ab8ff64
update key compatibility
felix5572 8240239
fix package import
felix5572 71e19ae
add unittest for ti_water.py; support field in old jsons
felix5572 82be973
update unittest for equi water calculation
felix5572 a72d34f
use mock conf file for hti_ice.py
felix5572 b061de4
update dpdispatcher in workflow
felix5572 77d0898
Merge pull request #7 from felix5572/master
amcadmus b206e6c
add github action auto release to pypi
felix5572 6d41dd4
update setup.py
felix5572 8ec85ac
Merge pull request #8 from felix5572/master
amcadmus 5648868
write info of hti_ice compute to result.json
mh-guo 1073723
prevent resources leaking
mh-guo 8ba66cb
Merge pull request #9 from mh-guo/master
amcadmus 831b8b5
update mock file
felix5572 c2fa300
update mock file in unittest
felix5572 835d0f4
Merge branch 'deepmodeling:master' into master
felix5572 d8266ab
transfer "dump.equi" from remote to local
Feiyang472 59601cc
Merge pull request #10 from felix5572/master
amcadmus 1ebd52b
Merge pull request #11 from Feiyang472/patch-1
amcadmus a066c98
Create DpFreeEnergyWater.py
mh-guo 6e7a6b9
Merge pull request #12 from mh-guo/master
amcadmus 7484f50
devel fix small bugs
felix5572 334c364
update conda CICD
felix5572 b3218e3
fix unittest
felix5572 5777439
fix conda CICD
felix5572 84a66c3
Fix wrong column index of enenthalpy.
shishaochen 487d28d
Fix Json parsing error.
shishaochen f11764b
Fix `if_meam` missing in Json config.
shishaochen 1b61936
Merge pull request #14 from shishaochen/fix
wanghan-iapcm 9db9f0b
Merge branch 'deepmodeling:master' into master
felix5572 a2e50c0
Allow to use relative path of input LAMMPS data.
shishaochen 7021421
Merge pull request #15 from shishaochen/fix
wanghan-iapcm 8fb7b2f
Fix out.lmp not downloaded.
shishaochen ba5c1e7
Allow relative model path in TI stage.
shishaochen 7522ac0
Dump absolute path of equi_conf & model to ti_settings.
shishaochen 3c5c86b
Merge pull request #16 from shishaochen/fix
wanghan-iapcm f53a986
Merge branch 'deepmodeling:master' into master
felix5572 edff7de
update airflow workflow
felix5572 23623ee
Merge pull request #20 from felix5572/master
wanghan-iapcm d8d3189
update gdi examples
felix5572 7ae81d5
update fields in machine.json
felix5572 5cd091b
Merge pull request #24 from felix5572/master
amcadmus 8265c72
Update old_equi.py (#28)
Chengqian-Zhang ea6452c
update pair_coeff (#30)
Chengqian-Zhang c362aab
fix codecov (#31)
njzjz 0b7cdc3
Update ti.py | enhancing data precision (#32)
Vibsteamer 7f61b60
add command line interface (#33)
Yi-FanLi 43aa25d
add pre-commit configs (#35)
njzjz 92af5d3
lib/water.py: correct making bond list of water (#36)
Yi-FanLi 3443bc8
add document (#34)
Yi-FanLi 2cb1053
raise warning for large stat_bsize value (#37)
Yi-FanLi 2f0c6c4
Support dump_freq keyword (#38)
Yi-FanLi df15ddc
use HTI's result.json file in TI's CLI (#39)
Yi-FanLi 224b191
fix hti's output of Helmholtz free energy for water
Yi-FanLi 4d98a04
fix hti's output of Helmholtz free energy for water (#40)
Yi-FanLi 590fcfc
Read HTI's target temperature and use it as To in TI (#42)
Yi-FanLi abf3fec
fix merge conflict
Yi-FanLi 551ba03
Fix the bug for the Langevin thermostat in HTI (#43)
Yi-FanLi 78fe73c
HTI: fix three-step lambda=1 error (#44)
Yi-FanLi 20c9188
support using P as control variable in Gibbs free energy (#41)
Yi-FanLi 2a30479
Merge branch 'deepmodeling:devel' into devel
Yi-FanLi f2388dd
Support running jobs through CLI (#45)
Yi-FanLi 79811b9
Merge branch 'devel' of github.com:Yi-FanLi/dpti into devel
Yi-FanLi 881ccec
fix gdi calculation y ndarray (#53)
felix5572 910e359
add more instructions, software usage and commands about dpti (#52)
felix5572 60502c6
Add examples for Sn high pressure and each calculation module (#51)
felix5572 db55d2c
update docker support; add docs and command instructions (#50)
felix5572 3ec59d5
Add mti (Mass Thermodynamic Integration) (#48)
Yi-FanLi 4156c17
CI: Setup Dependabot for GitHub Actions (#56)
njzjz-bot 691c9bc
CI: Bump codecov/codecov-action from v3 to v4 (#55)
njzjz-bot b66711b
Support custom command for the run_task functions (#61)
Yi-FanLi 9d3a857
support template forcefiled for mti (#60)
Yi-FanLi 9787d4e
CI: Mirror the repository to Gitee (#63)
njzjz-bot 9138f70
change TI MD final written frame file to final.lmp (#64)
Liu-RX cc882fb
feat(build): Add Git archives version files (#65)
njzjz-bot e4f79c4
fix: remove ref-names from .git_archival.txt (#66)
njzjz-bot af26a76
docs: pin sphinx-argparse to < 0.5.0 (#67)
njzjz-bot a07e9bc
correct error estimation: divide natoms in stead of np.sqrt(natoms)
Yi-FanLi 8db82a2
correct error estimation: divide natoms in stead of np.sqrt(natoms) (…
Yi-FanLi dbf3b46
Merge branch 'deepmodeling:devel' into devel
Yi-FanLi 8c29f7d
Merge branch 'devel' of github.com:Yi-FanLi/dpti into devel
Yi-FanLi 74c11c5
Bump actions/setup-python from 2 to 5 (#57)
dependabot[bot] c042df5
Bump actions/checkout from 2 to 4 (#58)
dependabot[bot] c81ae48
[pre-commit.ci] pre-commit autoupdate (#62)
pre-commit-ci[bot] 7e892a6
Merge branch 'deepmodeling:devel' into devel
Yi-FanLi 3c3a370
Improve error message when switching is not correctly set (#72)
Yi-FanLi e22ef9b
Support custom variables for the LAMMPS input files (#70)
Yi-FanLi f99465e
use P as control variable in Gibbs free energy for hti (#74)
Yi-FanLi 14a981f
Ti change e0 default value to None (#75)
GEODONG 621bb56
Merge branch 'deepmodeling:devel' into devel
Yi-FanLi c3ecb61
Improve the help message for the one-step switch HTI case of parser_r…
Yi-FanLi db59da6
use lammps thermo float to specify format for 'ke pe etotal enthalpy…
felix5572 1200e91
use lammps thermo float to specify format for 'ke pe etotal enthalpy…
felix5572 026ab27
first implementation for dpti on prefect framework
felix5572 b2ec5e4
first implementation for dpti on prefect framework
felix5572 4f35af1
add prefect dpdispatcher support
felix5572 3c9fbd9
add prefect dpdispatcher support
felix5572 d0076f9
install default example files
felix5572 ca540d1
install default example files
felix5572 e6a8cab
fix UT
felix5572 5d8bbc2
fix UT
felix5572 42ae24b
add default prefect usage instruction
felix5572 0b9a1d0
add default prefect usage instruction
felix5572 b568940
Merge branch 'devel' of https://mirror.ghproxy.com/https://github.com…
felix5572 d046593
Merge branch 'devel' of https://mirror.ghproxy.com/https://github.com…
felix5572 19c81d5
Merge branch 'deepmodeling:devel' into devel
Yi-FanLi 3360eb3
ti: read the pressure at the starting point on a p path (#77)
Yi-FanLi dedc736
[pre-commit.ci] pre-commit autoupdate
pre-commit-ci[bot] 5cf792a
docs: replace sphinx-rtd-theme with sphinx-book-theme (#79)
njzjz-bot 67ebf8f
Merge branch 'deepmodeling:devel' into devel
Yi-FanLi 1a2334d
pass element_num to sparam in hti_liq
Yi-FanLi 8beb7cc
pass element_num to sparam in hti_liq (#81)
Yi-FanLi ebd0a88
Merge pull request #73 from deepmodeling/pre-commit-ci-update-config
Yi-FanLi 68710aa
Bump codecov/codecov-action from 4 to 5 (#83)
dependabot[bot] 67449f7
add an example json file for mti
Yi-FanLi c95a0dc
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 04c22f7
Merge pull request #85 from Yi-FanLi/mti_example
Yi-FanLi bb98509
use temp instead of temp_list[ii] in _gen_lammps_input to avoid error…
Yi-FanLi 2609384
add an example json file for mti with p path
Yi-FanLi 565cf0c
Merge pull request #86 from Yi-FanLi/mti_p_path
Yi-FanLi 76fe53a
Merge branch 'deepmodeling:devel' into devel
felix5572 3bc24bd
Merge branch 'deepmodeling:devel' into devel
felix5572 898c4fc
Whole TI calculation prefect workflow
felix5572 de6ae21
Whole TI calculation prefect workflow
felix5572 8530fce
Split workflow code into multiple files
felix5572 8f2cec4
Split workflow code into multiple files
felix5572 594b0a1
extract out workflow
felix5572 564017d
extract out workflow
felix5572 95b1403
add confest.py for pytest
felix5572 3747fd5
add confest.py for pytest
felix5572 623dc23
add UT for job_executor and file_handler
felix5572 ad50f5e
add UT for job_executor and file_handler
felix5572 dd021a9
fix dumped in.json for hti_liq (#87)
Yi-FanLi 8087253
parse multiple epsilon values for lj/cut/soft (#88)
Yi-FanLi 40932f8
rewrite dpti workflow management and implement for prefect framework
felix5572 f061a9b
rewrite dpti workflow management and implement for prefect framework
felix5572 aefca89
clean old implementation
felix5572 1d84c8b
clean old implementation
felix5572 63864e3
small updates and bug fix for workflow implementation convenience
felix5572 238fd16
small updates and bug fix for workflow implementation convenience
felix5572 e76e956
clean unused code and notes
felix5572 1b29855
clean unused code and notes
felix5572 e844bdc
Merge branch 'deepmodeling:devel' into devel
felix5572 c76b61f
Merge branch 'deepmodeling:devel' into devel
felix5572 4c440a6
Merge branch 'devel' of https://github.com/felix5572/dpti into devel
felix5572 a74205a
Merge branch 'devel' of https://github.com/felix5572/dpti into devel
felix5572 70a4990
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 347d0ac
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] c408440
add example Sn high pressure
felix5572 8a0e679
add example Sn high pressure
felix5572 d8ba6fa
equi: write average position in out.lmp when if_dump_avg_posi=True (#90)
Yi-FanLi a25c159
add water ice example
felix5572 bec938a
add water ice example
felix5572 f090051
result base class implementation
felix5572 e293467
result base class implementation
felix5572 e60f63a
init result analyze rebulid free energy surface and compare ti result
felix5572 f505d72
init result analyze rebulid free energy surface and compare ti result
felix5572 52f9070
for IDE cursor use
felix5572 0cee3bb
for IDE cursor use
felix5572 d1a9c5c
use python abs import
felix5572 ebf99d8
use python abs import
felix5572 398adcf
init pytest unittest
felix5572 ac7cb1d
init pytest unittest
felix5572 fb429ed
add pytest unittest cli note
felix5572 b831d34
add pytest unittest cli note
felix5572 b644ded
Merge branch 'deepmodeling:devel' into devel
felix5572 8e3a1c6
Merge branch 'deepmodeling:devel' into devel
felix5572 9ba1d35
resolve conflicts
felix5572 ade6c26
resolve conflicts
felix5572 1255a30
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] e572496
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 0dac766
update Sn and water example conf file
felix5572 34b86be
update Sn and water example conf file
felix5572 e694a19
Merge branch 'devel' of https://github.com/felix5572/dpti into devel
felix5572 1327d04
add ai tools for dpti
felix5572 a883b79
Merge branch 'devel' of https://github.com/felix5572/dpti into devel
felix5572 483544d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 6b85bd3
Merge branch 'devel' of https://github.com/felix5572/dpti into devel
felix5572 d374484
devel fix bugs
felix5572 c05c9fd
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,61 @@ | ||
| --- | ||
| description: General Rules | ||
| globs: *py,*json,*yaml,*ipynb,*sh,*md,*txt,*.lammps,*tex,*toml,*yml | ||
| alwaysApply: false | ||
| --- | ||
|
|
||
| <!-- - You can @ files here | ||
| - You can use markdown but dont have to --> | ||
| [base.py](mdc:dpti/workflows/simulations/base.py) [equi.py](mdc:dpti/equi.py) [equi_sim.py](mdc:dpti/workflows/simulations/equi_sim.py) [ti.py](mdc:dpti/ti.py) [mti.py](mdc:dpti/mti.py) [ti_sim.py](mdc:dpti/workflows/simulations/ti_sim.py) [hti.py](mdc:dpti/hti.py) [hti_liq.py](mdc:dpti/hti_liq.py) [hti_ice.py](mdc:dpti/hti_ice.py) [hti_water.py](mdc:dpti/hti_water.py) [hti_sim.py](mdc:dpti/workflows/simulations/hti_sim.py) [einstein.py](mdc:dpti/einstein.py) [di.py](mdc:dpti/workflows/service/di.py) [file_handler.py](mdc:dpti/workflows/service/file_handler.py) [job_executor.py](mdc:dpti/workflows/service/job_executor.py) [ti_line_flow.py](mdc:dpti/workflows/flows/ti_line_flow.py) | ||
|
|
||
|
|
||
| # 角色 | ||
| 你是一名精通科学计算和分子动力学模拟的高级工程师,拥有10年以上的Python科学计算应用开发经验,熟悉LAMMPS、DeepMD-kit、Prefect等开发工具和技术栈。你的任务是帮助用户设计和开发易用且易于维护的分子动力学自由能计算应用。始终遵循科学计算领域的最佳实践,并坚持代码可重复性和计算效率的原则。 | ||
| # 目标 | ||
| 你的目标是以用户容易理解的方式帮助他们完成分子动力学自由能计算应用的设计和开发工作,确保计算结果准确可靠、性能高#效、用户使用便捷。 | ||
| # 要求 | ||
| 在理解用户需求、设计计算流程、编写代码、解决问题和项目迭代优化时,你应该始终遵循以下原则: | ||
| 项目初始化 | ||
| 仔细阅读项目的README.md,理解自由能计算的基本原理、计算流程和技术实现方案 | ||
| 如果没有README.md,创建一个包含计算理论基础、输入输出格式、依赖环境等信息的文档 | ||
| # 需求理解 | ||
| 理解用户的具体计算需求,包括体系类型、温度压力条件、所需精度等 | ||
| 选择合适的热力学积分方法,避免不必要的计算 | ||
| # 计算流程设计 | ||
| 使用Prefect设计可重复、可追踪的计算工作流 | ||
| 确保计算任务在不同计算环境下都能正确运行 | ||
| # 代码编写 | ||
| 技术选型: | ||
| Python科学计算库(numpy, scipy)用于数据处理和分析 | ||
| LAMMPS用于分子动力学模拟 | ||
| Prefect 框架用于工作流管理 | ||
| DeepMD-kit用于机器学习势能计算 | ||
| # 代码结构: | ||
| 模块化设计,将计算、分析、可视化等功能分离 | ||
| 使用面向对象编程,提高代码复用性 | ||
| 遵循Python科学计算代码规范 | ||
| # 计算安全性: | ||
| 检查输入参数的合法性 | ||
| 保存计算中间结果,支持断点续算 | ||
| 验证计算结果的物理合理性 | ||
| # 性能优化: | ||
| 优化并行计算策略 | ||
| 减少不必要的IO操作 | ||
| 合理使用内存缓存 | ||
| # 测试与文档: | ||
| 编写单元测试验证计算正确性 | ||
| 提供详细的API文档和使用示例 | ||
| 添加计算原理和方法的说明 | ||
| # 问题解决 | ||
| 全面理解分子动力学模拟和自由能计算的原理 | ||
| 根据计算结果的异常分析问题原因 | ||
| 确保代码修改不影响计算的物理正确性 | ||
| # 迭代优化 | ||
| 收集用户反馈,优化计算流程和接口设计 | ||
| 及时更新文档,包括新增功能和优化建议 | ||
| 持续改进计算性能和稳定性 | ||
| # 方法论 | ||
| 1.Unix编程风格,开源软件设计风格,恰当根据项目或者模块需要,使用设计模式 | ||
| 2.坚持dont repeat your self 原则 | ||
| 3.在软件架构上给出成熟考虑。 | ||
| 2.回答问题时,也给出关于设计模式上的思考,提示用户相关联的最佳实践(如果有)。 |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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,18 @@ | ||
| pass | ||
| # import importlib | ||
|
|
||
| # def _import_module(module_name): | ||
| # try: | ||
| # return importlib.import_module(f'dpti.workflows.{module_name}') | ||
| # except ImportError: | ||
| # return importlib.import_module(f'.{module_name}', package='dpti.workflows') | ||
|
|
||
| # MODULES_TO_IMPORT = [ | ||
| # 'job_executor', | ||
| # # 'another_module', | ||
| # # 'yet_another_module', | ||
| # ] | ||
|
|
||
| # # dynamically import sub modules | ||
| # for module_name in MODULES_TO_IMPORT: | ||
| # globals()[module_name] = _import_module(module_name) | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Commented-out module import system needs cleanup
The file contains a commented-out dynamic module import system with only a
passstatement active.Either:
The current state creates confusion about whether this functionality is intended to be used or not. If this is a work in progress, add a TODO comment explaining the plan.
📝 Committable suggestion