Function Repository Resource:

DistributeResourceFunctions

Source Notebook

Distribute resource function definitions to parallel kernels

Contributed by: Richard Hennigan (Wolfram Research)

ResourceFunction["DistributeResourceFunctions"][rf]

distributes metadata and definitions for the ResourceFunction given by rf to parallel kernels.

ResourceFunction["DistributeResourceFunctions"][{rf₁,rf₂,…}]

distributes multiple resource functions.

ResourceFunction["DistributeResourceFunctions"][rfs,ker]

distributes only to the kernels specified in ker.

Details and Options

The value for rf can be any of the following:

"name"

the name of a resource function

"uuid"

the UUID of a resource function

ResourceObject[…]

a resource object with type "Function"

ResourceFunction[…]

a resource function

All

all resource functions loaded in the current session

ResourceFunction["DistributeResourceFunctions"] applies itself recursively to any resource functions found appearing in the definition of rf.

ResourceFunction["DistributeResourceFunctions"] is similar to DistributeDefinitions, but it also preloads ResourceObject metadata in each parallel kernel so they do not need to read the resource from disk.

ResourceFunction["DistributeResourceFunctions"] will automatically launch parallel kernels if necessary.

New kernels launched after distributing resource functions will not automatically have resource functions distributed.

If a resource function has already been distributed to all kernels, it is not distributed again.

ResourceFunction["DistributeResourceFunctions"][rf] is effectively equivalent to ResourceFunction["DistributeResourceFunctions"][rf,Kernels[]].

Examples

Basic Examples (3)

Distribute resource function definitions to parallel kernels:

In[1]:=

Out[1]=

Now the function can be used quickly on each kernel:

In[2]:=

Out[2]=

Compare to a function that has not been distributed:

In[3]:=

Out[3]=

Scope (4)

Distribute multiple resource functions at once:

In[4]:=

Out[4]=

Using a resource function loads it into the current session:

In[5]:=

Out[5]=

Distribute all currently loaded resource functions to parallel kernels:

In[6]:=

Out[6]=

Only functions that have not been distributed yet will be sent to parallel kernels:

In[7]:=

Out[7]=

In[8]:=

Out[8]=

Distribute to specific kernels:

In[9]:=

Out[9]=

Compare initial timing with other kernels:

In[10]:=

Out[10]=

In[11]:=

Out[11]=

Properties and Relations (4)

Normally, initial loading time for resource functions increases with the number of parallel kernels, because each kernel must read the definition sequentially:

In[12]:=