ResourceRegister

✖
`ResourceRegister`

[Experimental]

✖

ResourceRegister[resource]

creates a persistent cache of a resource object that can be referenced by name.

✖

ResourceRegister[resource, loc]

stores the resource in persistence location loc.

✖

ResourceRegister[resource, {loc₁,…}]

stores the resource in multiple persistence locations.

Details and Options

The resource can be either a ResourceObject or ResourceFunction.
The resource cache contains both metadata and contents.
The persistence locations can be any of the values supported by PersistenceLocation.
ResourceRegister[resource] is equivalent to ResourceRegister[resource,$PersistenceBase].
Registering a private resource allows it to be referenced by name in ResourceObject[name] and other appropriate functions.
Additional functions that accept a registered resource name depend on the resource's "ResourceType".
Resources from a public Wolfram repository can always be found using ResourceObject[name] without using ResourceRegister.
ResourceRegister[resource] returns the resource.
DeleteObject removes both the resource registry and any local cache of the resource.
If the resource is registered in a "Local" PersistenceLocation, the resource content will be cached locally with LocalCache[resource].
If the resource is registered in a "Cloud" PersistenceLocation, the resource content will be deployed to the cloud with CloudDeploy[resource].

Examples

open allclose all

Basic Examples (2)Summary of the most common use cases

Create a data resource:

In[1]:=1

✖

https://wolfram.com/xid/0btn4thfgo02-gcldru

Out[1]=1

Register the resource:

In[2]:=2

✖

https://wolfram.com/xid/0btn4thfgo02-oxgg6

Out[2]=2

Retrieve the data by using the resource name in ResourceData:

In[3]:=3

✖

https://wolfram.com/xid/0btn4thfgo02-bjp8th

Register a ResourceFunction:

In[1]:=1

✖

https://wolfram.com/xid/0btn4thfgo02-38cpbf

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0btn4thfgo02-qlcedc

Out[2]=2

Reference the function by name:

In[3]:=3

✖

https://wolfram.com/xid/0btn4thfgo02-klp46s

Out[3]=3

Scope (2)Survey of the scope of standard use cases

Create a new data resource:

In[1]:=1

✖

https://wolfram.com/xid/0btn4thfgo02-kh3qt

Out[1]=1

The resource is not discoverable by name:

In[2]:=2

✖

https://wolfram.com/xid/0btn4thfgo02-flpx68

Out[2]=2

Registering the resource allows it to be discovered by name:

In[3]:=3

✖

https://wolfram.com/xid/0btn4thfgo02-d85j5t

Out[3]=3

Create a new neural net resource:

In[1]:=1

✖

https://wolfram.com/xid/0btn4thfgo02-ffncuv

Out[1]=1

Register the resource locally and in the Wolfram Cloud:

In[2]:=2

✖

https://wolfram.com/xid/0btn4thfgo02-cyjeed

Out[2]=2

Properties & Relations (2)Properties of the function, and connections to other functions

Resource registration persists between sessions:

In[1]:=1

✖

https://wolfram.com/xid/0btn4thfgo02-d0h6xx

Out[1]=1

Register the resource and Quit the kernel session:

In[2]:=2

✖

https://wolfram.com/xid/0btn4thfgo02-c8bq31

The resource is cached to disk and can be referenced by name:

In[3]:=3

✖

https://wolfram.com/xid/0btn4thfgo02-jd1dnb

Out[3]=3

Resource registrations remain until they are removed:

In[1]:=1

✖

https://wolfram.com/xid/0btn4thfgo02-w5v3hi

Out[1]=1

DeleteObject removes the resource from the registry:

In[2]:=2

✖

https://wolfram.com/xid/0btn4thfgo02-otwe3r

Out[2]=2

Possible Issues (1)Common pitfalls and unexpected behavior

Registering a second resource with an identical name will replace the original resource in the registry:

In[1]:=1

✖

https://wolfram.com/xid/0btn4thfgo02-u27qxk

In[2]:=2

✖

https://wolfram.com/xid/0btn4thfgo02-h5th08

In[3]:=3

✖

https://wolfram.com/xid/0btn4thfgo02-edb7h0

Out[3]=3

In[4]:=4

✖

https://wolfram.com/xid/0btn4thfgo02-cxnqpa

Out[4]=4

Referencing the resource by name will give the new result:

In[5]:=5

✖

https://wolfram.com/xid/0btn4thfgo02-hlees5

Out[5]=5

The first resource still exists and can be used with the ResourceObject:

In[6]:=6

✖

https://wolfram.com/xid/0btn4thfgo02-mmh8t

Out[6]=6

Top