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

Python API for 1.0 #75

Open
1 of 6 tasks
ryanmrichard opened this issue Oct 12, 2022 · 0 comments
Open
1 of 6 tasks

Python API for 1.0 #75

ryanmrichard opened this issue Oct 12, 2022 · 0 comments

Comments

@ryanmrichard
Copy link
Member

ryanmrichard commented Oct 12, 2022

A 1.0 of ParallelZone requires the Python API to be finalized, decently performant, and unit tested. To that end I started PR: #74. The aforementioned PR currently showcases several of the more general issues found on the Python API project board.

I specifically want to call out (sub bullets refer back to the #74):

  • Import time (more general issue)
    • The serial Python unit tests barely do anything and they take over 5x longer than the C++ tests
    • I haven't profiled, but I'm guessing this is import overhead, this issue should be updated if it's not
      • This is based on the times from Python unittest times being similar to the C++ times, but the final wall time is one to two orders of magnitude slower.
  • MPI overhead (more general issue)
    • The MPI overhead is visible, but admittedly not too appreciable at this point (about half a second; C++ unit tests saw half that). It's possible that fleshing out more unit tests may add to to the overhead, or that we can ignore the overhead for ParallelZone. More profiling should be done.
  • Import syntax (more general issue)
    • A 1.0 requires us to finalize the API, so while a minor annoyance, this is critical for a release
  • Auto-generated __init__.py file (more general issue)
    • Same as above data point
  • Unit tests of Python bindings of exposed C++
  • Documentation of Python API.
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

No branches or pull requests

1 participant