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.

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

Add warmstart implementation for warmstart from reference points #111

Open
wants to merge 46 commits into
base: topic/humble-devel/refactor
Choose a base branch
from

Conversation

kzorina
Copy link
Contributor

@kzorina kzorina commented Dec 11, 2024

No description provided.

Copy link
Collaborator

@ArthurH91 ArthurH91 left a comment

Choose a reason for hiding this comment

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

few comments on order of imports & the test class could have docstrings to explain what's tested in each test, but otherwise looks good

agimus_controller/agimus_controller/warm_start_base.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@MaximilienNaveau MaximilienNaveau left a comment

Choose a reason for hiding this comment

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

There are some issues with the WarmStartBase API.
Take a look at how the MPC is actually using it.
This is the proper API. I am sorry I have not seen it in the previous PR.

agimus_controller/agimus_controller/warm_start_base.py Outdated Show resolved Hide resolved
agimus_controller/tests/test_warm_start.py Outdated Show resolved Hide resolved
Copy link
Contributor

@Kotochleb Kotochleb left a comment

Choose a reason for hiding this comment

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

When I think of it now, maybe the documentation should be filled in on the WarmStartBase class side and then it can be assumed to be inherited later on.

It should also be extended in the base class and WarmStartReference is still missing a loat of documentation

@kzorina kzorina requested a review from Kotochleb December 13, 2024 12:46
Copy link
Contributor

@Kotochleb Kotochleb left a comment

Choose a reason for hiding this comment

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

Just a few cosmetic changes. Otherwise, it's ok. I have weird feeling about those asserts, but I will be a hypocrite to tell you to do this and later change my mind

@kzorina kzorina requested a review from Kotochleb December 22, 2024 16:51
@Kotochleb
Copy link
Contributor

I forgot to mention. Please take a look at this. This is an official documentation for google doc string formatting for the sphinx plugin. This is the formatting we want to expect to create sphinx documentation out of it

@kzorina kzorina requested a review from Kotochleb January 7, 2025 12:59
Copy link
Contributor

@Kotochleb Kotochleb left a comment

Choose a reason for hiding this comment

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

Encoding in the files and module docstrings still needs to be discussed

...

@abstractmethod
def setup(self, *args, **kwargs) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

I think no args and kwargs are needed in here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Shouldn't it allow for some arguments in the child classes? Ithouth those, I would assume it's an argumentless method

agimus_controller/agimus_controller/warm_start_base.py Outdated Show resolved Hide resolved
Copy link

@MedericFourmy MedericFourmy left a comment

Choose a reason for hiding this comment

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

tests are passing (after adding the unittest.main() call)

@kzorina kzorina requested a review from MedericFourmy January 7, 2025 15:04
list[npt.NDArray[np.float64]],
]:
"""
Generate initial values for a warm-start of the optimization problem.

Choose a reason for hiding this comment

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

I think we could follow the docstring format of warm_start_base.py here too for consistancy.

Also, I would explain the fact that the returned control trajectory init_us at the start of the description, after the sentence "Generate initial values..." (the fact that it is computed from RNEA and not taken from the initial_state.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants