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

[docs] Parallelization tutorial #5184

Merged
merged 11 commits into from Feb 6, 2023
Merged

Conversation

da-woods
Copy link
Contributor

I've written a parallelization tutorial. It doesn't cover that much new ground from the main parallelization documents, but hopefully it present a separate example of each use case, and is a little less of "here are the parameters, good luck" than the main parallelization reference

Kind of closes #5125

I think it's breaking clang
Copy link
Contributor

@matusvalo matusvalo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huge +1 for this tutorial! I found just some small typos for now. One note regarding the PR, pure python is missing but this can be done even in next PR + the tutorial uses also new keyword which is missing in pure python mode.

docs/src/tutorial/parallelization.rst Outdated Show resolved Hide resolved
docs/src/tutorial/parallelization.rst Outdated Show resolved Hide resolved
docs/src/tutorial/parallelization.rst Outdated Show resolved Hide resolved
docs/src/tutorial/parallelization.rst Outdated Show resolved Hide resolved
Co-authored-by: Matus Valo <matusvalo@users.noreply.github.com>
@da-woods
Copy link
Contributor Author

pure python is missing

Mainly laziness...

the tutorial uses also new keyword which is missing in pure python mode

We could use a malloced array in pure Python mode (with a note that the code isn't quite identical). It doesn't really matter for the example whether the storage is a vector or an raw memory block.

@matusvalo
Copy link
Contributor

Mainly laziness...

No worries. We can go even with this version and I am willing to migrate it to pure python mode afterwards.

@da-woods
Copy link
Contributor Author

I've added the pure Python examples. Unlike the rest of the documentation I've put the Cython examples first. Mainly because I prefer it that way. Obviously with it being open source other people can come in later and swap that around but I thought I'd do it my way initially.

Co-authored-by: Matus Valo <matusvalo@users.noreply.github.com>
Copy link
Contributor

@matusvalo matusvalo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another batch of possible improvements

docs/src/tutorial/parallelization.rst Show resolved Hide resolved
docs/src/tutorial/parallelization.rst Show resolved Hide resolved
docs/src/tutorial/parallelization.rst Show resolved Hide resolved
Co-authored-by: Matus Valo <matusvalo@users.noreply.github.com>
Copy link
Contributor

@matusvalo matusvalo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@da-woods da-woods added this to the 3.0 milestone Feb 6, 2023
@da-woods
Copy link
Contributor Author

da-woods commented Feb 6, 2023

I'm going to merge this. It's docs so it's not going to break anything...

@da-woods da-woods merged commit b24286d into cython:master Feb 6, 2023
@da-woods da-woods deleted the parallel_tutorial branch February 6, 2023 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENHWhere is the openMP documentation
2 participants