The documentation #17
Merged
Conversation
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
commit f640cfd Author: Lev Kozlov <[email protected]> Date: Fri Oct 4 06:45:06 2024 +0900 feat: add packaging and formatting rules (#9) * wip: start reworking structure of the project * wip: components system for task init * wip: finish reimplementing tasks * wip: barriers reimplementation is done * wip: remove requilred model argument from the component * wip: intermediate commit to checkout * wip: solver's structure draft finished * wip: reorganize hierarchy and imports * wip: constrained local IK example init * wip: the minimal example is launched * wip: working example * feat: finalized local IK with complete working example * feat: update pyproject.toml * feat: working global IK example * example: local IK vmapped * example: global ik vmapped * chore: rename examples * wip: output vmapping init * feat: add packaging and formatting rules * fix: update ruff command * feat: delete empty contructors, add context manager and make working example for local IK with output batching * refactor: remove redundant .wxyz_xyz call * feat: add mask as default parameter for all components * fix: many small bugs introduced by mask introduction * feat: reorganize solvers, introducing SolverSolution * example: finalize all examples, everything is working * Squashed commit of the following: commit d9a25bc Author: Ivan Domrachev <[email protected]> Date: Sat Aug 31 18:24:51 2024 +0300 chore: update example prints commit b101918 Author: Ivan Domrachev <[email protected]> Date: Sat Aug 31 18:18:33 2024 +0300 example: make example easier to compare with new structure * refactor: remove legacy examples and move working ones * chore: minor fixes * feat: compatibility with the python 3.10 * refactor: mypy static typization * refactor: additional refactoring * hotfix: typo in pyproject.toml * fix: repair examples * wip: init * tests: finilize tests for task components * test: write tests for solvers * wip: intermediate test status * wip: minor fixes * wip: barrier tests init * tests: body frame test * test: position task tests * fix: adapt CoM and joint tasks for possible vmap * test: configuration tests * refactor: minor test updates * test: remove non-implemented tests * refactor: minor adjustments to style * [refactor]: auto-tracking of attributes modification (#11) * refactor: automatically mark modified variables * hotfix: remove test file * hotfix: remove another example file * refactor: more beautiful access * [refactor]: Building all JaxComponent from Component class (#12) * refactor: automatically mark modified variables * hotfix: remove test file * hotfix: remove another example file * refactor: more beautiful access * refactor: generalize creation of JaxComponents * refactor: removing _build_component methods * hotfix: remove test.py from examples * fix: return _build_component method * type: mask specified to be Sequence[int] * refactor: move limit type to the typing class * feat: self-collision avoidance barrier * example: add full self-collision avoidance to the simple jit-ted example * fix: proper order of geometry types in get_distance * tests: self collision barrier tests init * chore: remove print * refactor: add name to SelfCollisionBarrier.gain argument * Finalizing tests (#16) * test: finish configuration tests * test: abstract body barrier test * test: body position barrier * tests: joint barrier test * test: self collision barrier test * refactor: small test improvements * feat: documentation * fix: maximum position in position barrier * tests: example-based tests * wip: documentation init * docs: typing docs * docs: base solver documentation * docs: global IK solver documentation * docs: local IK documentation * docs: barrier updates & documentation * docs: finalize barriers documentation and base documentation * docs: tasks documentation * chore: small changes * feat: add packaging and formatting rules * fix: update ruff command * ci: fix pyproject.toml * refactor: autorefactor * ci: add test workflows * wip: CI fix attempt * ci: fix coverage and add static typing check * hotfix: fix bulid * hotfix: yet another try to fix mypy check * ci: disable coveralls bot and add GH badges * ci: split jobs on separate workflows * hotfix: master -> name, workflow triggers --------- Co-authored-by: Ivan Domrachev <[email protected]> Co-authored-by: Simeon Nedelchev <[email protected]>
commit 31757f9 Author: Ivan Domrachev <[email protected]> Date: Fri Oct 4 02:29:15 2024 +0300 hotfix: set default velocity limits to Problem commit de2a58f Author: Ivan Domrachev <[email protected]> Date: Fri Oct 4 02:27:53 2024 +0300 chore: set version to 0.1.0 commit 5302c43 Author: Ivan Domrachev <[email protected]> Date: Fri Oct 4 02:26:49 2024 +0300 chore: add README.md and CONTRIBUTING.md commit f640cfd Author: Lev Kozlov <[email protected]> Date: Fri Oct 4 06:45:06 2024 +0900 feat: add packaging and formatting rules (#9) * wip: start reworking structure of the project * wip: components system for task init * wip: finish reimplementing tasks * wip: barriers reimplementation is done * wip: remove requilred model argument from the component * wip: intermediate commit to checkout * wip: solver's structure draft finished * wip: reorganize hierarchy and imports * wip: constrained local IK example init * wip: the minimal example is launched * wip: working example * feat: finalized local IK with complete working example * feat: update pyproject.toml * feat: working global IK example * example: local IK vmapped * example: global ik vmapped * chore: rename examples * wip: output vmapping init * feat: add packaging and formatting rules * fix: update ruff command * feat: delete empty contructors, add context manager and make working example for local IK with output batching * refactor: remove redundant .wxyz_xyz call * feat: add mask as default parameter for all components * fix: many small bugs introduced by mask introduction * feat: reorganize solvers, introducing SolverSolution * example: finalize all examples, everything is working * Squashed commit of the following: commit d9a25bc Author: Ivan Domrachev <[email protected]> Date: Sat Aug 31 18:24:51 2024 +0300 chore: update example prints commit b101918 Author: Ivan Domrachev <[email protected]> Date: Sat Aug 31 18:18:33 2024 +0300 example: make example easier to compare with new structure * refactor: remove legacy examples and move working ones * chore: minor fixes * feat: compatibility with the python 3.10 * refactor: mypy static typization * refactor: additional refactoring * hotfix: typo in pyproject.toml * fix: repair examples * wip: init * tests: finilize tests for task components * test: write tests for solvers * wip: intermediate test status * wip: minor fixes * wip: barrier tests init * tests: body frame test * test: position task tests * fix: adapt CoM and joint tasks for possible vmap * test: configuration tests * refactor: minor test updates * test: remove non-implemented tests * refactor: minor adjustments to style * [refactor]: auto-tracking of attributes modification (#11) * refactor: automatically mark modified variables * hotfix: remove test file * hotfix: remove another example file * refactor: more beautiful access * [refactor]: Building all JaxComponent from Component class (#12) * refactor: automatically mark modified variables * hotfix: remove test file * hotfix: remove another example file * refactor: more beautiful access * refactor: generalize creation of JaxComponents * refactor: removing _build_component methods * hotfix: remove test.py from examples * fix: return _build_component method * type: mask specified to be Sequence[int] * refactor: move limit type to the typing class * feat: self-collision avoidance barrier * example: add full self-collision avoidance to the simple jit-ted example * fix: proper order of geometry types in get_distance * tests: self collision barrier tests init * chore: remove print * refactor: add name to SelfCollisionBarrier.gain argument * Finalizing tests (#16) * test: finish configuration tests * test: abstract body barrier test * test: body position barrier * tests: joint barrier test * test: self collision barrier test * refactor: small test improvements * feat: documentation * fix: maximum position in position barrier * tests: example-based tests * wip: documentation init * docs: typing docs * docs: base solver documentation * docs: global IK solver documentation * docs: local IK documentation * docs: barrier updates & documentation * docs: finalize barriers documentation and base documentation * docs: tasks documentation * chore: small changes * feat: add packaging and formatting rules * fix: update ruff command * ci: fix pyproject.toml * refactor: autorefactor * ci: add test workflows * wip: CI fix attempt * ci: fix coverage and add static typing check * hotfix: fix bulid * hotfix: yet another try to fix mypy check * ci: disable coveralls bot and add GH badges * ci: split jobs on separate workflows * hotfix: master -> name, workflow triggers --------- Co-authored-by: Ivan Domrachev <[email protected]> Co-authored-by: Simeon Nedelchev <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds simple docstrings in
sphinxformat for all the classes.