Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Features

Feat: add ruff and codespell integration by @XuehaiPan in PR #186.

Fixes

Documentation

v0.2.2

Fixes

Add MANIFEST.in by @Borong Zhang in PR #182.

Documentation

Update api documentation by @Jiayi Zhou in PR #181

v0.2.1

Features

Feat(statistics tools): support statistics tools for experiments by @Borong Zhang in PR #157.

v0.2.0

Features

Support cuda by @Jiayi Zhou in PR #163.
Support command line interfaces for omnisafe by @Borong Zhang in PR #144.
Refactor(wrapper): refactor the cuda setting by @Jiayi Zhou in PR #176.

Fixes

Fix(onpolicy_adapter): fix the calculation of last state value by @Borong Zhang in PR #164.
Fix(config.py): fix config assertion by @Jiayi Zhou in PR #174.
Fix autoreset wrapper in by @r-y1 PR #167.

Documentation

Update docs style by @Jiayi Zhou in PR #169.
Fix typo in readme by @Ruiyang Sun in PR #172.
Update README and the usage of CLI by @Jiaming Ji in PR #138.

v0.1.0

Check out Development for more.

Development

2023-03-06 ~ 2023-03-15

Features

Chore(on-policy): update benchmark performance for first-order algorithms by @Borong Zhang in PR #148.
Feat(off-policy): add DDPG, TD3 SAC by @Jiayi Zhou in PR #128.
Feat: support policy evaluation by @Jiayi Zhou in PR #137.
Test: add more test case, and fix bugs by @Ruiyang Sun in PR #136.
Fix(logger, wrapper): support csv file and velocity tasks by @Jiayi Zhou in PR #131.
Feat: update architecture of config.yaml by @Jiaming Ji in PR #126.
Chore: support num_thread setting by @Jiayi Zhou in PR #124.
Refactor: change architecture of omnisafe by @Ruiyang Sun in PR #121.

Fixes

Fix(on-policy): fix the second order algorithms performance by @Jiayi Zhou in PR #147.
Fix(rollout, exp_grid): fix logdir path conflict by @Borong Zhang in PR #145.
Fix: support new config for exp_grid by @Borong Zhang in PR #142.
Fix(ppo): fix entropy loss by @Jiayi Zhou in PR #135.
Fix(algo): fix no return in algo_wrapper::learn by @Ruiyang Sun in PR #122.

Documentation

Docs: Update changelog by @Jiaming Ji.
Docs: Update README.md: fix action passing by @Jiayi Zhou in PR #149.
Chore: fix typo by @1Asan in PR #134.

2023-02-27 ~ 2023-03-05

Fixes

Fix(P3O): fix P3O performance by @Jiayi Zhou in PR #123.
Fix(off-policy): fix action passing by @Jiayi Zhou in PR #119.

Documentation

Docs: update logo by @Jiayi Zhou in PR #125.

2023-02-13 ~ 2023-02-19

Fixes

Fix(evaluator): fix evaluator by @Ruiyang Sun in PR #117.

2023-02-06 ~ 2023-02-12

Features

Build(env): delete local safety-gymnaisum dependence by @Ruiyang Sun in PR #102.
Refactor(buffer): refactor buffer by @Ruiyang Sun in PR #101.
Refactor: clean the code by @Jiayi Zhou in

Fixes

Fix: fix tools by @Jiayi Zhou in PR #100.
Fix: fix algo wrapper by @Jiayi Zhou in PR #99. PR #97.

Documentation

Modify logo.png and add requirements.txt by @Ruiyang Sun in PR #103.

2023-01-30 ~ 2023-02-05

Features

Chore: update linter settings by @XuehaiPan.
Chore: update ci by @Jiayi Zhou in PR #90 reviewed by @Jiaming Ji and @friedmainfunction.
Chore: update yaml by @Jiayi Zhou in PR #92 and #93 reviewed by @Jiaming Ji and @friedmainfunction.

2023-01-23 ~ 2023-01-29

Features

Refactor(objects): change object type into free_geom by @Borong Zhang in PR #89.
Chore: update algorithms configuration by @Jiayi Zhou in PR #88.
Feat: support cuda by [@Jiayi Zhou](https://github.com/Gaiejj in PR #86.
Feat(render): add keyboard debug mode for some agents in all tasks by @Borong Zhang in PR #83.
Feat: add experiment grid by @Jiaming Ji in PR #84.

Fixes

Fix seed setting by @Jiayi Zhou in PR #82.

2023-01-16 ~ 2023-01-22

Features

Feat(agents): add ant agent by @Borong Zhang in PR #82.
Refactor(safety-gymnaisum): code decoupling by @Borong Zhang in PR #81.
Feat: add new algorithm by @Jiayi Zhou in PR #80.

2023-01-09 ~ 2023-01-15

Features

Refactor: change wrapper setting by @Jiayi Zhou in PR #73.
Feat: vectorized environment by @Jiayi Zhou in PR #74.

2023-01-02 ~ 2023-01-08

Features

Feat(agents, tasks, Evaluator): support circle012 and new agent racecar, update evaluator by @Borong Zhang in PR #59.

2022-12-26 ~ 2023-01-01

Features

Refactor: enhanced model-based code, add CAP algorithm by @Weidong Huang in PR #59.
Feat: support auto render as .mp4 videos, add examples and tests by @Borong Zhang in PR #60.

Fixes

Fix(model-based): fix cap cost bug and lag beta value in cap.yaml by @Weidong Huang in PR #62.
Fix(render): fix markers are not shown in the rgb array returned by env.render() by @Borong Zhang in PR #61.

2022-12-19 ~ 2022-12-25

Features

Feat(circle, run): support new tasks by @Borong Zhang in PR #50.
Add Makefile by @XuehaiPan in PR #53.

Fixes

Fix bug for namedtuple by @Jiayi Zhou in PR #54.

Documentation

Fix spelling error by @Jiayi Zhou in PR #56, reviewed by @Jiaming Ji and @XuehaiPan.

2022-12-12 ~ 2022-12-18

Features

Refactor: open pylint in pre-commit by @Jiaming Ji in PR #48.
Refactor: change the details and yaml files of on policy algorithm by @Jiayi Zhou in PR #41.
Feat: add CUP algorithm by @Jiayi Zhou in PR #43.
Feat(wrapper): separated wrapper for different algorithmic environments by @Jiaming Ji in PR #44.
Chore: rename files and enable pylint by @Borong Zhang in PR #39.

Documentation

Retouch the formatting and add PPO docs for omnisafe by @Jiayi Zhou in PR #40.
Add Lagrangian method documentation by @Jiayi Zhou in PR #42.
Refactor(README): show the implemented algorithms in more detail by @Jiaming Ji in PR #47.

2022-12-05 ~ 2022-12-11

Features

Refactor: more OOP style code were used and made better code and file structure by @Borong Zhang in PR #37.
Refactor: change the file layout of omnisafe by @Jiaming Ji in PR #35.

Fixes

Fix(env_wrapper): fix warning caused by 'none' string default value by @Borong Zhang in PR #30.

Documentation

Docs: retouch the formatting and add links to the formula numbers by @Jiayi Zhou in PR #31.

2022-11-28 ~ 2022-12-04

Features

Chore(.github): update issue templates by @XuehaiPan in PR #29.
Refactor packaging by @XuehaiPan in PR #20.
Add ddpg, clean some code, modify algo_wrapper in PR #24 by @Jiaming Ji.

Documentation

Add TRPO to docs by @Jiayi Zhou in PR #28.
Add FOCOPS and PCPO to docs by @XuehaiPan in #21.

2022-11-20 ~ 2022-11-27

Features

Add render_mode: human, rgb_array, depth_array in safety-gymnasium: safety_gym_v2.
Add Model-based Safe Algorithms: mbppolag, safeloop by @Weidong Huang in #12.
Add .editorconfig and update license by @XuehaiPan in #8.

Fixes

Fix readme typo by @erjanmx in PR #13.
Fix ambiguous config yaml for algorithms by @Jiaming Ji in PR #6.
Fix vis safety_gym_v2 with del the render_mode by @Jiaming Ji in PR #3.

Documentation

Refactor some code in omnisafe, add CHANGELOG.md,` and del install.md and tutorial in PR #16 by @Jiaming Ji.
Docs: add PCPO in omnisafe's docs and modify CPO by @Jiayi Zhou in #9.
Add CPO and Intro in omnisafe's docs by @Jiayi Zhou in PR #7.
Add render mode and vision input in safety-gymnasium: safety_gym_v2 by @Jiaming Ji in PR #5.