TrainState
==========

.. currentmodule:: penzai.deprecated.v1.toolshed.basic_training

.. autoclass:: TrainState
  :members:
  :special-members:
  :show-inheritance:


  
  
    
    
    
    
    
    
    
    

  

  
  
  
  
  
  
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    

  
  .. rubric:: Methods
  .. autosummary::
  
    
    ~TrainState.__init__
    
    
    
    
    ~TrainState.initial_state
    
    
    
    
    
    
    
  

  
  .. rubric:: Attributes
  .. autosummary::
  
    ~TrainState.model
    ~TrainState.step
    ~TrainState.root_rng
    ~TrainState.params
    ~TrainState.model_without_params
    ~TrainState.opt_state
    ~TrainState.loss_fn_state
    ~TrainState.optimizer_def
  

  

  .. rubric:: Inherited Methods
  .. raw:: html

    <details style="margin-bottom: 1.5rem">
      <summary style="font-style:italic">(expand to view inherited methods)</summary>

  .. autosummary::
  
    
    
    ~TrainState.attributes_dict
    
    
    ~TrainState.from_attributes
    
    
    
    ~TrainState.key_for_field
    
    
    ~TrainState.select
    
    
    ~TrainState.tree_flatten
    
    
    ~TrainState.tree_flatten_with_keys
    
    
    ~TrainState.tree_unflatten
    
    
    ~TrainState.treescope_color
    

  .. raw:: html

    </details>