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

fix(get-exp-result-import): fix the import of get_experiment_result #85

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

idocx
Copy link
Member

@idocx idocx commented Oct 8, 2024

… at the top of the package and change the function name in the doc from get_experiment_results to get_experiment_result

Summary

Include a summary of major changes in bullet points:

  • Feature 1
  • Feature 2
  • Fix 1
  • Fix 2

Additional dependencies introduced (if any)

  • List all new dependencies needed and justify why. While adding dependencies that bring
    significantly useful functionality is perfectly fine, adding ones that add trivial
    functionality, e.g., to use one single easily implementable function, is frowned upon.
    Provide a justification why that dependency is needed. Especially frowned upon are
    circular dependencies.

TODO (if any)

If this is a work-in-progress, write something about what else needs to be done.

  • Feature 1 supports A, but not B.

Checklist

Work-in-progress pull requests are encouraged, but please put [WIP] in the pull request
title.

Before a pull request can be merged, the following items must be checked:

  • Code is in the standard Python style.
    The easiest way to handle this is to run the following in the correct sequence on
    your local machine. Start with running black on your new code. This will
    automatically reformat your code to PEP8 conventions and removes most issues. Then run
    pycodestyle, followed by flake8.
  • Docstrings have been added in theNumpy docstring format.
    Run pydocstyle on your code.
  • Type annotations are highly encouraged. Run mypy to
    type check your code.
  • Tests have been added for any new functionality or bug fixes.
  • All linting and tests pass.

Note that the CI system will run all the above checks. But it will be much more
efficient if you already fix most errors prior to submitting the PR. It is highly
recommended that you use the pre-commit hook provided in the repository. Simply
cp pre-commit .git/hooks and a check will be run prior to allowing commits.

… at the top of the package and change the function name in the doc from `get_experiment_results` to `get_experiment_result`
@idocx idocx linked an issue Oct 8, 2024 that may be closed by this pull request
@idocx idocx merged commit b5618d2 into main Oct 8, 2024
7 checks passed
@idocx idocx deleted the fix-get-exp-result-import branch October 8, 2024 17:12
@idocx
Copy link
Member Author

idocx commented Oct 8, 2024

All the tests are passed. Merge it to the main branch

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.

[Bug]: no get_experiment_results
1 participant