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

Mention {mirai} in {future} docs #111

Merged
merged 2 commits into from
Feb 10, 2025
Merged

Mention {mirai} in {future} docs #111

merged 2 commits into from
Feb 10, 2025

Conversation

jcheng5
Copy link
Member

@jcheng5 jcheng5 commented Nov 25, 2024

Sorry @shikokuchuo, I just realized I had these changes sitting locally, uncommitted. I thought I had published this ages ago.

@shikokuchuo
Copy link
Member

Thanks Joe!

My first thoughts on those bullets are:

  1. mirai actually has a general interface for launching remote workers and is being used on Slurm clusters, for example this community-contributed example. I know that future is designed to be a general API, but I'm not sure that actually translates into it being able to be used in more places.
  2. I think the key here is that mirai is queued, so nested topologies automatically work without having to carefully manage them like future - so this is definitely a positive for mirai, but doesn't quite read as such!

I also think it's definitely worth mentioning that:

  • mirai promises are event-driven rather than polling (much more efficient, lower latency)

The following may tie into 4 above, that mirai is inherently queued:

  • mirai is always non-blocking and doesn't require the use of future_promise()

Hope the above makes sense for you. I'd be happy to suggest wording, but I also don't want to put words in your mouth! Let me know what you prefer or if you have any questions on the above.

@jcheng5
Copy link
Member Author

jcheng5 commented Nov 26, 2024

Please feel free to edit. I don't even know what I wrote, this was months ago!

@shikokuchuo
Copy link
Member

Please feel free to edit. I don't even know what I wrote, this was months ago!

Thanks Joe, I've gone ahead and added suggestions. Please feel free to re-word any of them. If there's anything I can make clearer for you do feel free to ask!

@shikokuchuo
Copy link
Member

@jcheng5 I've added a final point about task cancellation. It would be good to get this merged. Thanks!

@jcheng5 jcheng5 marked this pull request as ready for review February 10, 2025 17:21
@jcheng5 jcheng5 merged commit f5f887c into main Feb 10, 2025
30 of 31 checks passed
@jcheng5 jcheng5 deleted the mirai-docs branch February 10, 2025 17:32
@jcheng5
Copy link
Member Author

jcheng5 commented Feb 11, 2025

Took some messing around with the version number (initially the updated docs only went to the /dev/ URL path), but it's updated now.

@shikokuchuo
Copy link
Member

Thanks!

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.

2 participants