Codebook

pydantic model vision_architectures.layers.codebook.CodebookConfig

Bases: CustomBaseModel

Show JSON schema

{
   "title": "CodebookConfig",
   "type": "object",
   "properties": {
      "num_vectors": {
         "title": "Num Vectors",
         "type": "integer"
      },
      "dim": {
         "title": "Dim",
         "type": "integer"
      },
      "revive_dead_vectors_after_n_steps": {
         "default": 100,
         "title": "Revive Dead Vectors After N Steps",
         "type": "integer"
      },
      "ema_decay": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.99,
         "title": "Ema Decay"
      }
   },
   "required": [
      "num_vectors",
      "dim"
   ]
}

Config:

• arbitrary_types_allowed: bool = True

• extra: str = ignore

• validate_default: bool = True

• validate_assignment: bool = True

• validate_return: bool = True

Fields:

• dim (int)

• ema_decay (float | None)

• num_vectors (int)

• revive_dead_vectors_after_n_steps (int)

Validators:

field num_vectors: int [Required]

Validated by:

• validate

• validate_before

field dim: int [Required]

Validated by:

• validate

• validate_before

field revive_dead_vectors_after_n_steps: int = 100

Validated by:

• validate

• validate_before

field ema_decay: float | None = 0.99

Validated by:

• validate

• validate_before

class vision_architectures.layers.codebook.Codebook(config={}, use_ema=True, **kwargs)

Bases: Module, PyTorchModelHubMixin

__init__(config={}, use_ema=True, **kwargs)

Initialize internal Module state, shared by both nn.Module and ScriptModule.

calculate_perplexity(indices)

calculate_losses(x, z)

quantize(x)

revive_dead_vectors()

forward(x, channels_first=None)

Define the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.