def __str__(self):
        """
        Returns a brief summary of the encoder and how it is configured,
        including which energy and weight updates are used, and 
        how the energy minimum is found.
        """
        summary = """

        Energy-based Pooler
        ---------------
        
        Configuration...

         - input size  : {self.input_size}
         - output size : {self.output_size}
         - code weight : {self.code_weight}
         - sparsity    : {self.sparsity}
         - Boost_b     : {self.boost_strength_bias}
         - Boost_H     : {self.boost_strength_hidden}
         - incr, decr  : {self.weight_incr}, {self.weight_decr}
         - LR_hidden   : {self.learning_rate_hidden}
         - LR_bias     : {self.learning_rate_bias}
        
        Docstrings...
        
        **initialize connections**
        {init_weights}

        **encode**
        {encode_doc}

        **update weights:**
        {update_doc}
        
        **energy:**
        {energy_doc}

        **find energy minimum:**
        {min_doc}

        ---------------

        """
        summary = trim_doc(summary)
        summary = summary.format(self=self, 
                                 init_weights = trim_doc(self.initialize_connections.__doc__),
                                 encode_doc = trim_doc(self.encode.__doc__),
                                 energy_doc = trim_doc(self.energy.__doc__),
                                 update_doc = trim_doc(self.update_weights.__doc__),
                                 min_doc    = trim_doc(self.find_energy_minimum.__doc__))
        return summary
def __str__ ( self ) : summary = """
        Energy-based Pooler
        ---------------
        Configuration...
         - input size  : {self.input_size}
         - output size : {self.output_size}
         - code weight : {self.code_weight}
         - sparsity    : {self.sparsity}
         - Boost_b     : {self.boost_strength_bias}
         - Boost_H     : {self.boost_strength_hidden}
         - incr, decr  : {self.weight_incr}, {self.weight_decr}
         - LR_hidden   : {self.learning_rate_hidden}
         - LR_bias     : {self.learning_rate_bias}
        Docstrings...
        **initialize connections**
        {init_weights}
        **encode**
        {encode_doc}
        **update weights:**
        {update_doc}
        **energy:**
        {energy_doc}
        **find energy minimum:**
        {min_doc}
        ---------------
        """ summary = trim_doc ( summary ) summary = summary . format ( self = self , init_weights = trim_doc ( self . initialize_connections . __doc__ ) , encode_doc = trim_doc ( self . encode . __doc__ ) , energy_doc = trim_doc ( self . energy . __doc__ ) , update_doc = trim_doc ( self . update_weights . __doc__ ) , min_doc = trim_doc ( self . find_energy_minimum . __doc__ ) ) return summary
Returns a brief summary of the encoder and how it is configured,
        including which energy and weight updates are used, and 
        how the energy minimum is found.