---
title: "ParameterDict"
sidebar_label: "ParameterDict"
description: "The clika_runtime.nn ParameterDict class."
---

<!-- Generated by tools/api_reference/generate_api_docs.py. Do not edit. -->

ParameterDict(parameters=None)

    A registered, insertion-ordered mapping from names to parameters; look
    them up in your own ``forward``. A plain tensor stored under a key
    becomes a :class:`~clika_runtime.nn.Parameter`; any other object is
    stored as is. Constructed from a mapping or an iterable of
    ``(key, value)`` pairs.
    

## `__init__`

```python
__init__(self, parameters: 'Mapping[str, Any] | Iterable[tuple[str, Any]] | None' = None) -> 'None'
```

Initialize self.  See help(type(self)) for accurate signature.

## `clear`

```python
clear(self) -> 'None'
```

clear() -> None

Remove every entry.

## `copy`

```python
copy(self) -> "'ParameterDict'"
```

copy() -> ParameterDict

A new ParameterDict holding the same entries.

## `extra_repr`

```python
extra_repr(self) -> 'str'
```

extra_repr() -> str

One line of per-class detail for :meth:`__repr__`; a layer prints
its geometry here (``in_features=64, out_features=256``).

## `fromkeys`

```python
fromkeys(self, keys: 'Iterable[str]', default: 'Any' = None) -> "'ParameterDict'"
```

fromkeys(keys, default=None) -> ParameterDict

A new ParameterDict with ``default`` under every key.

## `get`

```python
get(self, key: 'str', default: 'Any' = None) -> 'Any'
```

get(key, default=None) -> Any

The entry under ``key``, or ``default`` when absent.

## `items`

```python
items(self) -> 'Iterable[tuple[str, Any]]'
```

items() -> the (key, value) pairs, in insertion order.

## `keys`

```python
keys(self) -> 'Iterable[str]'
```

keys() -> the keys, in insertion order.

## `pop`

```python
pop(self, key: 'str') -> 'Any'
```

pop(key) -> Any

Remove and return the entry under ``key``.

## `popitem`

```python
popitem(self) -> 'tuple[str, Any]'
```

popitem() -> (key, value)

Remove and return the most recently inserted entry.

## `setdefault`

```python
setdefault(self, key: 'str', default: 'Any' = None) -> 'Any'
```

setdefault(key, default=None) -> Any

Store ``default`` under ``key`` when the key is absent; return the
entry under ``key``.

## `update`

```python
update(self, parameters: 'Mapping[str, Any] | Iterable[tuple[str, Any]]') -> 'None'
```

update(parameters) -> None

Add the entries of a mapping (an unordered mapping is added in
sorted key order), or of an iterable of ``(key, value)`` pairs,
overwriting existing keys.

## `values`

```python
values(self) -> 'Iterable[Any]'
```

values() -> the values, in insertion order.