Moved parallel docs out of helpDB, updated and improved them #17681
Conversation
|
Mac failure seems unrelated. Anybody have thoughts on this? |
| """ | ||
| Base.cluster_cookie() -> cookie | ||
|
|
||
| Returns the cluster cookie, by default the `LocalProcess` cookie. |
There was a problem hiding this comment.
Reference to LocalProcess can be removed. It is not really mentioned in the docs anywhere and should also be probably unexported - not really relevant/useful in user code.
|
Thanks for doing this. |
| @@ -59,6 +78,12 @@ end | |||
|
|
|||
| shift!(c::Channel) = take!(c) | |||
|
|
|||
| """ | |||
| isready(c::Channel) | |||
efcbb33
to
ed2f97f
Compare
| @@ -299,8 +299,6 @@ General Parallel Computing Support | |||
|
|
|||
| Called by cluster managers using custom transports. It should be called when the custom transport implementation receives the first message from a remote worker. The custom transport must manage a logical connection to the remote worker and provide two ``IO`` objects, one for incoming messages and the other for messages addressed to the remote worker. If ``incoming`` is ``true``\ , the remote peer initiated the connection. Whichever of the pair initiates the connection sends the cluster cookie and its Julia version number to perform the authentication handshake. | |||
|
|
|||
| .. function:: Future() | |||
There was a problem hiding this comment.
Eaten by a rebase, I think.
On Jul 31, 2016, at 19:17, Tony Kelman [email protected] wrote:
In doc/stdlib/parallel.rst #17681 (comment):
@@ -299,8 +299,6 @@ General Parallel Computing Support
Called by cluster managers using custom transports. It should be called when the custom transport implementation receives the first message from a remote worker. The custom transport must manage a logical connection to the remote worker and provide two ``IO`` objects, one for incoming messages and the other for messages addressed to the remote worker. If ``incoming`` is ``true``\ , the remote peer initiated the connection. Whichever of the pair initiates the connection sends the cluster cookie and its Julia version number to perform the authentication handshake.-.. function:: Future()
where did this go?—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub https://github.com/JuliaLang/julia/pull/17681/files/c5307064cef6a7b31f0ea8c3e4e8c69d5fe9b240..ed2f97f71ed7b876a6989284cffefb8250baeaa2#r72917653, or mute the thread https://github.com/notifications/unsubscribe-auth/AAyk47Iek7ZNt8vYmH8GesblknEEWny1ks5qbVdUgaJpZM4JXmvy.
There was a problem hiding this comment.
Oh, actually, it's extraneous now that I have the default argument shown in the other Future docstring.
|
@tkelman thoughts? Good to go? @amitmurthy as well |
f4a76c6
to
b0d12f1
Compare
| """ | ||
| procs(pid::Integer) | ||
|
|
||
| Returns a list of all process identifiers visible to worker `pid`. |
There was a problem hiding this comment.
Returns a list of all process identifiers on the same physical node. Specifically all workers bound to the same ip-address as pid are returned.
There was a problem hiding this comment.
This is used by shared arrays to identify the subset of workers on remote nodes.
ad35a5f
to
9e74347
Compare
| @@ -121,7 +121,7 @@ own such constructs.) | |||
|
|
|||
| An important thing to remember is that, once fetched, a :class:`Future` will cache its value | |||
| locally. Further :func:`fetch` calls do not entail a network hop. Once all referencing | |||
| :class:`Future`\ s have fetched, the remote stored value is deleted. | |||
| :class:`Future` s have fetched, the remote stored value is deleted. | |||
There was a problem hiding this comment.
This might have been necessary? Not sure how it changes the rendering.
There was a problem hiding this comment.
Yes, \ is needed if the character after a backtick isn't whitespace.
9e74347
to
a51f6cc
Compare
|
|
||
| .. Docstring generated from Julia source | ||
|
|
||
| Returns a list of all process identifiers visible to worker ``pid``\ . The result depends on the topology of the workgroup. |
There was a problem hiding this comment.
missing a make docs run. should squash this too, probably
Moved a bunch of docstrings inline. Changed things to reflect the code that's actually in `multi.jl`. Documented `RemoteException`.
a51f6cc
to
f28a4ef
Compare
|
Ran |
|
Thanks for all the help & review, @tkelman and @amitmurthy. |
Moved a bunch of docstrings inline. Changed things to reflect
the code that's actually in
multi.jl. DocumentedRemoteException.cc: @amitmurthy (again, sorry!)