Skip to content

Commit f860bc0

Browse files
Removed redundant brackets
1 parent 29e6430 commit f860bc0

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,36 +85,36 @@ Simulator(graph).simulate(source, destination, num_episodes=100, plot=True)
8585
## 📦 Contents <a name = "contents"></a>
8686

8787
### Graph
88-
(`aco_routing.utils.graph.Graph`)
88+
`aco_routing.utils.graph.Graph`
8989
- A Directed Graph class which consists of `Nodes` and `Edges`.
9090
- The `evaporation_rate` is initialized here.
9191

9292
### Node
93-
(`aco_routing.utils.graph.Node`)
93+
`aco_routing.utils.graph.Node`
9494
- A `Node` class which represents a node in the Graph and consists of various outgoing edges.
9595

9696
### Edge
97-
(`aco_routing.utils.graph.Edge`)
97+
`aco_routing.utils.graph.Edge`
9898
- An `Edge` class which represents a link between 2 nodes in the Graph.
9999
- Each `Edge` has 2 parameters:
100100
- `travel_time`: The amount of time it takes to traverse the edge. A high value indicates more traffic.
101101
- `pheromones`: A heuristic parameter i.e., the pheromone values deposited by the ants.
102102

103103
### Dijkstra
104-
(`aco_routing.dijkstra.Dijkstra`)
104+
`aco_routing.dijkstra.Dijkstra`
105105
- The baseline algorithm to compare the results of the candidate algorithm with.
106106
- The Dijkstra's algorithm ([source](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm)) returns the shortest path between any 2 nodes in a graph.
107107

108108
### Ant
109-
(`aco_routing.utils.ant.Ant`)
109+
`aco_routing.utils.ant.Ant`
110110
- The `Ant` class representing an ant that traverses the graph.
111111

112112
### ACO
113-
(`aco_routing.aco.ACO`)
113+
`aco_routing.aco.ACO`
114114
- The traditional Ant Colony Optimization algorithm that spawns various ants at random nodes and tries to find the shortest path between the specified source and destination.
115115

116116
### Simulator
117-
(`aco_routing.utils.simulator.Simulator`)
117+
`aco_routing.utils.simulator.Simulator`
118118
- The simulator class is used to simulate and evaluate the performance of the candidate algorithm (ACO) with a baseline Dijkstra's Algorithm.
119119
- It simulates a real-life city, where the traffic conditions change every episode in a conditionally stochastic manner.
120120
- The ants continue to find the shortest path even after the traffic conditions change.

0 commit comments

Comments
 (0)