clean up

kyegomez · Sep 30, 2023 · 3c7b7a4 · 3c7b7a4
1 parent ce01ffe
commit 3c7b7a4
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "swarms-torch"
-version = "0.0.1"
+version = "0.0.2"
 description = "swarms-torch - Pytorch"
 license = "MIT"
 authors = ["Kye Gomez <kye@apac.ai>"]

diff --git a/swarms_torch/ant_colony_swarm.py b/swarms_torch/ant_colony_swarm.py
@@ -19,6 +19,16 @@ class AntColonyOptimization:
         Number of ants
     evaporation_rate: float
         Evaporation rate
+
+    Usage
+    -----
+    from swarms_torch import AntColonyOptimization
+
+    goal_string = "Hello ACO"
+    aco = AntColonyOptimization(goal_string, num_iterations=1000)
+    best_solution = aco.optimize()
+    
+    print("Best Matched String:", best_solution)
     
     Features to implement
     --------