.. _pyrogue_tree_model:

=========
Model API
=========

PyRogue models define how variable values are represented, converted to/from
bytes, and interpreted for display/type behavior.

Most users interact with models indirectly through variable ``base`` and related
type configuration. Advanced users can use model classes directly for custom
encoding/decoding workflows.

Related Documentation
=====================

For advanced block/variable interaction details, see
:doc:`/pyrogue_tree/blocks_advanced`.

Utility Functions
=================

See :doc:`/api/python/wordcount` for generated API details.
See :doc:`/api/python/bytecount` for generated API details.
See :doc:`/api/python/reversebits` for generated API details.
See :doc:`/api/python/twoscomplement` for generated API details.

Base Model
==========

See :doc:`/api/python/model` for generated API details.

Common Built-in Models
======================

See :doc:`/api/python/uint` for generated API details.

See :doc:`/api/python/int` for generated API details.

See :doc:`/api/python/bool` for generated API details.

See :doc:`/api/python/string` for generated API details.

See :doc:`/api/python/float` for generated API details.

See :doc:`/api/python/double` for generated API details.

See :doc:`/api/python/fixed` for generated API details.

See :doc:`/api/python/ufixed` for generated API details.