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

Draft #669

Closed
Closed

Conversation

reubenharry
Copy link
Contributor

@reubenharry reubenharry commented May 12, 2024

Remove option to give initial_position from run_inference_algorithm.

Description:

run_inference_algorithm currently uses a try-except clause to allow the user to either provide an initial position or an initial state. This has led to some problems, when the except clause fails to trigger.

More broadly, there doesn't seem to be a good reason to

Solution:

Make run_inference_algorithm only take initial_state, so that the caller of run_inference_algorithm is responsible for providing initial_state from initial_position, rather than deferring this task.

A few important guidelines and requirements before we can merge your PR:

  • The branch is rebased on the latest main commit;
  • Commit messages follow these guidelines;
  • The code respects the current naming conventions;
  • Docstrings follow the numpy style guide
  • pre-commit is installed and configured on your machine, and you ran it before opening the PR;
  • There are tests covering the changes;
  • The doc is up-to-date;

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.

1 participant