Update

Author: r3v1

README.md

@@ -22,7 +22,7 @@ pip install git+https://github.com/r3v1/tf-SmeLU
 
 ````python
 import tensorflow as tf
-from smelu import smelu
+from tf_smelu import smelu
 
 x = tf.range(-6, 6, 1, dtype=float)  # <tf.Tensor: numpy=array([-6., -5., -4., -3., -2., -1.,  0.,  1.,  2.,  3.,  4.,  5.], dtype=float32)>
 

examples/example.py

@@ -25,7 +25,7 @@ def main():
     axs[1].set_title("SmeLU gradients")
     axs[1].grid()
     plt.tight_layout()
-    plt.savefig("example.jpg")
+    # plt.savefig("example.jpg")
     plt.show()
 
 

tf_smelu/smelu.py

@@ -14,6 +14,16 @@ def smelu(x: Union[list, tf.Tensor], beta: float = 1.):
     beta: float
         Half-width of a symmetric transition region around x = 0
         
+    Examples
+    --------
+    >>> import tensorflow as tf
+    >>> from tf_smelu import smelu
+    
+    >>> x = tf.range(-6, 6, 1, dtype=float)
+    # <tf.Tensor: numpy=array([-6., -5., -4., -3., -2., -1.,  0.,  1.,  2.,  3.,  4.,  5.], dtype=float32)>
+    >>> smelu(x, beta=0.1)
+    # <tf.Tensor: numpy=array([0., 0., 0., 0., 0., 0., 0.025, 1., 2., 3., 4., 5.], dtype=float32)>
+        
     See Also
     --------
     - https://arxiv.org/pdf/2202.06499.pdf