[RTM] random_initial_condition_example #486

EveCharbie · 2022-06-15T20:29:47Z

@Ipuch and @pariterre
This is what I had in mind for the random initial guess.
For the cuteness and where to put it, I'll let you do it or tell me exactly what you want.

This change is

Ipuch

Reviewable status: 0 of 1 files reviewed, 3 unresolved discussions (waiting on @EveCharbie and @Ipuch)

bioptim/examples/getting_started/custom_initial_guess.py line 60 at r1 (raw file):

    return my_values[:, 0] + (my_values[:, -1] - my_values[:, 0]) * current_shooting_point / n_shooting

def generate_random_initial_guess(bounds: Bounds,

I would create this as a method of InitialGuess and add an extra argument of a new class called Noise.

it would look like this:

n = Noise(bounds, scaling, n_element: int)
x = InitialGuess(x, interpolation=initial_guess, noise=n)

bioptim/examples/getting_started/custom_initial_guess.py line 75 at r1 (raw file):

    scaling: int or list
        The amplitude of the gaussian noise generated
    n_elements: int

I'm not sure what it is.

bioptim/examples/getting_started/custom_initial_guess.py line 99 at r1 (raw file):

        return bounds_min_matrix, bounds_max_matrix

    bound_push = 0.1

This could be a nice option too :)

pariterre

Seems very good. I've left some minor changes to make and it should be ready to merge :)

Reviewed 6 of 6 files at r2, all commit messages.
Reviewable status: all files reviewed, 9 unresolved discussions (waiting on @EveCharbie and @Ipuch)

bioptim/examples/getting_started/custom_initial_guess.py line 60 at r1 (raw file):

Previously, Ipuch (Pierre Puchaud) wrote…

I would create this as a method of InitialGuess and add an extra argument of a new class called Noise.

it would look like this:
n = Noise(bounds, scaling, n_element: int)
x = InitialGuess(x, interpolation=initial_guess, noise=n)

makes sense, NoiseInitialGuess works for me too

bioptim/examples/getting_started/custom_initial_guess.py line 67 at r2 (raw file):

    n_shooting: int,
    final_time: float,
    automatic_random_init: bool = False,

I know this is in an example, so not so much important... I feel that automatic in the name is a bit overkill... if you ask for random_init it is kind of implied that you won't have to provided the noise, therefore it is automatic... Maybe just random_init would be less confusing?

bioptim/examples/getting_started/custom_initial_guess.py line 155 at r2 (raw file):

            bounds=x_bounds,
            bound_t=None,
            scaling=1,

is scaling the magnitude of the noise? If so, could we find a better term?

bioptim/limits/path_conditions.py line 873 at r2 (raw file):

        self.n_elements = n_elements

        self.type = init_interpolation

Could you double check that you actually have to override this many properties (it may be). I was just feeling for instance that bound should be set from the super().__ini__(bound=bound, **parameters)? Maybe there is no bound parameters and I am just confused!

bioptim/limits/path_conditions.py line 898 at r2 (raw file):

        self.create_noise_matrix()
        self.init = InitialGuess(self.noised_initial_guess, interpolation=InterpolationType.EACH_FRAME).init

Doesn't super().__init__ already take care of this?

bioptim/limits/path_conditions.py line 902 at r2 (raw file):

        self.type = InterpolationType.EACH_FRAME

    def create_noise_matrix(self):

This should probably be a protected method (_create_noise_matrix)

tests/test_global_getting_started.py line 332 at r2 (raw file):

@pytest.mark.parametrize("interpolation", InterpolationType)
@pytest.mark.parametrize("ode_solver", [OdeSolver.RK4, OdeSolver.RK8, OdeSolver.IRK])
def test_initial_guesses(automatic_random_init, interpolation, ode_solver):

if you decide to remove the automatic you will have to do it here too

EveCharbie

Reviewable status: all files reviewed, 9 unresolved discussions (waiting on @EveCharbie, @Ipuch, and @pariterre)

bioptim/examples/getting_started/custom_initial_guess.py line 155 at r2 (raw file):