cornucopia.ctx

include

include(transform, keys, union=True)

Bases: Transform

Context manager for keys to include

Use as a transform

from cornucopia import IncludeKeysTransform
newxform = IncludeKeysTransform(xform, "image)
image, label = newxform(image=image, label=label)

Use as a context manager with as

from cornucopia import IncludeKeysTransform
with IncludeKeysTransform(xform, "image") as newxform:
    image, label = newxform(image=image, label=label)

Use as a context manager with

from cornucopia import IncludeKeysTransform
with IncludeKeysTransform(xform, "image"):
    image, label = xform(image=image, label=label)

Use as a context manager (alias)

from cornucopia import ctx
with ctx.include(xform, "image") as newxform:
    image, label = newxform(image=image, label=label)

Parameters:

Name	Type	Description	Default
`transform`	`Transform`	Transform to apply	required
`keys`	`[sequence of] str`	Keys to include	required
`union`	`bool`	Include the union of what was already included and `keys`	`True`

exclude

exclude(transform, keys, union=True)

Bases: Transform

Context manager for keys to exclude. Can also be used as a transform.

Use as a transform

from cornucopia import ExcludeKeysTransform
newxform = ExcludeKeysTransform(xform, "image)
image, label = newxform(image=image, label=label)

Use as a context manager with as

from cornucopia import ExcludeKeysTransform
with ExcludeKeysTransform(xform, "image") as newxform:
    image, label = newxform(image=image, label=label)

Use as a context manager with

from cornucopia import ExcludeKeysTransform
with ExcludeKeysTransform(xform, "image"):
    image, label = xform(image=image, label=label)

Use as a context manager (alias)

from cornucopia import ctx
with ctx.exclude(xform, "image") as newxform:
    image, label = newxform(image=image, label=label)

Parameters:

Name	Type	Description	Default
`transform`	`Transform`	Transform to apply	required
`keys`	`[sequence of] str`	Keys to include	required
`union`	`bool`	Exclude the union of what was already excluded and `keys`	`True`

consume

consume(transform, keys, union=True)

Bases: Transform

Context manager for keys to consume. Can also be used as a transform.

Use as a transform

from cornucopia import ConsumeKeysTransform
newxform = ConsumeKeysTransform(xform, "image)
label = newxform(image=image, label=label)

Use as a context manager with as

from cornucopia import ConsumeKeysTransform
with ConsumeKeysTransform(xform, "image") as newxform:
    label = newxform(image=image, label=label)

Use as a context manager with

from cornucopia import ConsumeKeysTransform
with ConsumeKeysTransform(xform, "image"):
    label = xform(image=image, label=label)

Use as a context manager (alias)

from cornucopia import ctx
with ctx.consume(xform, "image") as newxform:
    label = newxform(image=image, label=label)

Added in v0.5

Parameters:

Name	Type	Description	Default
`transform`	`Transform`	Transform to apply	required
`keys`	`[sequence of] str`	Keys to include	required
`union`	`bool`	Consume the union of what was already consumed and `keys`	`True`

shared

shared(transform, mode=UNSET)

Bases: SharedMixin, Transform

Context manager for sharing transforms across channels / tensors. Can also be used as a transform.

Use as a context manager (alias)

from cornucopia import ctx
with ctx.shared(xform, "channels") as newxform:
    image = newxform(image)

Parameters:

Name	Type	Description	Default
`transform`	`Transform`	Transform to apply	required
`mode`	`(channels, tensors, channels + tensor, '')`	'channel': the same transform is applied to all channels in a tensor, but different transforms are used in different tensors. 'tensors': the same transform is applied to all tensors, but with a different transform for each channel. 'channels+tensors' or True: the same transform is applied to all channels of all tensors. None or False: A different transform is applied to each channel and each tensor.	`'channels'`

returns

returns(transform, returns=None)

Bases: Transform

Context manager for sharing transforms across channels / tensors

Use as a context manager (alias)

from cornucopia import ctx
with ctx.returns(xform, "channels") as newxform:
    image = newxform(image)

maybe

maybe(transform, prob=0.5, *, shared=True, **kwargs)

Bases: SharedMixin, Transform

Randomly apply a transform

20% chance of adding noise

import cornucopia as cc
gauss = cc.GaussianNoiseTransform()

Explicit call to the class:

 img = cc.MaybeTransform(gauss, 0.2)(img)

Implicit call using syntactic sugar:

img = (0.2 * gauss)(img)

```

Default for shared changed from False to True

Parameters:

Name	Type	Description	Default
`transform`	`Transform`	A transform to randomly apply	required
`prob`	`float`	Probability to apply the transform	`0.5`
`shared`	`(channels, tensors, channels + tensor, '')`	Roll the dice once for all input tensors	`'channels'`

switch

switch(transforms, prob=0, *, shared=True, **kwargs)

Bases: SharedMixin, Transform

Randomly choose a transform to apply

Randomly apply either Gaussian or Chi noise

import cornucopia as cc
gauss = cc.GaussianNoiseTransform()
chi = cc.ChiNoiseTransform()

Explicit call to the class:

img = cc.SwitchTransform([gauss, chi])(img)

Implicit call using syntactic sugar:

img = (gauss | chi)(img)

Functional call:

img = cc.switch({gauss: 0.5, chi: 0.5})(img)

Default for shared changed from False to True

Parameters:

Name	Type	Description	Default
`transforms`	`list[Transform]`	A list of transforms to sample from	required
`prob`	`list[float]`	Probability of applying each transform	`0`
`shared`	`(channels, tensors, channels + tensor, '')`	Roll the dice once for all input tensors	`'channels'`

map

map(*mapargs, nested=False, default=None, **mapkwargs)

Bases: Transform

Transforms that are applied to specific positional or arguments

Example

img = torch.randn([1, 32, 32])
seg = torch.randn([3, 32, 32]).softmax(0)

# positional variant
trf = MappedTransform(GaussianNoise(), None)
img, seg = trf(img, seg)

# keyword variant
trf = MappedTransform(image=GaussianNoise())
img, seg = trf(image=img, label=seg)

# alternative version
dat = {'img': torch.randn([1, 32, 32]),
       'seg': torch.randn([3, 32, 32]).softmax(0)}
dat = MappedTransform(img=GaussianNoise(), nested=True)(dat)

Parameters:

Name	Type	Description	Default
`mapargs`	`tuple[Transform]`	Transform to apply to positional arguments	`()`
`mapkwargs`	`dict[str, Transform]`	Transform to apply to keyword arguments	`{}`
`nested`	`bool`	Recursively traverse the inputs until we find matching dictionaries. Only `mapkwargs` are accepted if "nested".	`False`
`default`	`Transform`	Transform to apply if nothing is specifically mapped	`None`

randomize

randomize(transform, sample=tuple(), ksample=dict(), *, shared=False, **kwargs)

Bases: NonFinalTransform

Transform generated by randomizing some parameters of another transform.

ctx.randomize is an alias for RandomizedTransform

Gaussian noise with randomized variance

Object call

import cornucopia as cc
hypernoise = cc.RandomizedTransform(cc.GaussianNoise, [cc.Uniform()])
img = hypernoise(img)

Delayed call

import cornucopia as cc
MyRandomNoise = cc.randomize(cc.GaussianNoise)
hypernoise = MyRandomNoise(cc.Uniform())
img = hypernoise(img)

Parameters:

Name	Type	Description	Default
`transform`	`callable(...) -> Transform`	A Transform subclass or a function that constructs a Transform.	required
`sample`	`[list or dict of] callable`	A collection of functions that generate parameter values provided to `transform`. Can be args-like or kwargs-like arguments.	`tuple()`
`ksample`	`dict[callable]`	Must be kwargs-like arguments.	`dict()`

Other Parameters:

Name	Type	Description
`shared`	`(channels, tensors, channels + tensors, '')`	Share random parameters across tensors and/or channels

batch

batch(transform)

Bases: Module

Apply a transform to a batch

Example

Functional call:

batched_transform = cc.ctx.batch(transform)
img, lab = batched_transform(img, lab)  # input shapes: [B, C, X, Y, Z]

Object call:

batched_transform = cc.BatchedTransform(transform)
img, lab = batched_transform(img, lab)  # input shapes: [B, C, X, Y, Z]

Parameters:

Name	Type	Description	Default
`transform`	`Transform`	Transform to apply to a batched tensor or to a nested structure of batched tensors	required