Skip to content

Cleaner docs with snippets for using Minibatcher #550

Description

@odunbar

Issue

Following on from #537. We should provide more information to users about the procedure users should use in setting up the minibatching experiment. In particular we are missing

  • That once we have created the Observation series, the user does not need to manually call update_minibatcher - just update ensemble.
  • To retrieve the next minibatch indices one should call e.g. get_current_minibatch(get_observation_series(ekp))

Possible solution

  • Add the API get_current_minibatch(ekp) so that people don't need to retrieve the observation series,
  • Add code snippets to the docs (front and centre) on how to call ekp with minibatching, including update_ensemble! and get_current_minibatch(ekp)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions