Merge pull request #78 from rickhg12hs/README_spelling

Update README.md:  minor spelling, grammar, formatting

Author: harpomaxx

README.md

@@ -1,23 +1,25 @@
 # NetSecGameAgents
-Agents located in this repository should be use in the [Network Security Game](https://github.com/stratosphereips/NetSecGame) environment. They are intented for a navigation and problem solving in the adversarial network-security based environment where they play role of attackers or defenders.
+Agents located in this repository should be used in the [Network Security Game](https://github.com/stratosphereips/NetSecGame) environment. They are intended for navigation and problem solving in the adversarial network-security based environment where they play the role of attackers or defenders.
 
 ## BaseAgent
-All future agents should extend BaseAgent - a minimal implementation of agent capable of interaction with he environment. The base agent also implement logging capabilities for the agent via the `logging` module of python. The logger can be accessed by property `logger`.
+All future agents should extend BaseAgent - a minimal implementation of agent capable of interaction with the environment. The base agent also implements logging capabilities for the agent via the `logging` python module. The logger can be accessed by property `logger`.
 
 For creating an instance of a `BaseAgent`, three parameters have to be used:
-1. `host:str` - URL where the game server runs
-2. `port: int` - port number where  game server runs
+1. `host: str` - URL where the game server runs
+2. `port: int` - port number where game server runs
 3. `role: str` - Intended role of the agent. Options are `Attacker`, `Defender`, `Human`
 
-When extending the `BaseAgent`, these args should be passed to in the constructor by calling:
-```super().__init__(host, port, role)```
+When extending the `BaseAgent`, these args should be passed to the constructor by calling:
+```
+super().__init__(host, port, role)
+```
 
 There are 4 important methods to be used for interaction with the environment:
 
-1. `register()`: Should be used ONCE in the beginning of the interaction to register the agent in the game. 
+1. `register()`: Should be used ONCE at the beginning of the interaction to register the agent in the game. 
     - Uses the class name and `role` specified in the initialization for the registration in the game
     - returns `Observation` which contains the status of the registration and the initial `GameState` if the registration was successful
-2. `make_step(Action: action)`: Used for sending a `Action` object to be used as a next step of the agent. Returns `Observation` with new state fo the environment after the action was applied.
+2. `make_step(Action: action)`: Used for sending an `Action` object to be used as a next step of the agent. Returns `Observation` with new state of the environment after the action was applied.
 3. `request_game_reset()`: Used to RESET the state of the environment to its initial position (e.g. at the end of an episode). Returns `Observation` with state of the environment.
 4. `terminate_connection()`: Should be used ONCE at the end of the interaction to properly disconnect the agent from the game server. 
 
@@ -35,7 +37,7 @@ There are three types of roles an agent can play in NetSecEnv:
 Agents of each type are stored in the corresponding directory within this repository:
 ```
 ├── agents
-    ├── attakcers
+    ├── attackers
         ├── concepts_q_learning
         ├── double_q_learning
         ├── gnn_reinforce
@@ -48,11 +50,11 @@ Agents of each type are stored in the corresponding directory within this reposi
         ├── benign_random
 ```
 ### Agent utils
-Utility functions in [agent_utils.py](./agents/agent_utils.py) can be used by any agent to evaluate a `GameState`, generate set of valid `Actions` in a `GameState` etc. 
+Utility functions in [`agent_utils.py`](./agents/agent_utils.py) can be used by any agent to evaluate a `GameState`, and generate a set of valid `Actions` in a `GameState`, etc. 
 Additionally, there are several files with utils functions that can be used by any agents:
-- `[agent_utils.py](./agents/agent_utils.py) Formatting GameState and generation of valid actions
-- [graph_agent_utils.py](./agents/graph_agent_utils.py): GameState -> graph conversion
-- [llm_utils.py](./agents/llm_utils.py): utility functions for LLM-based agents
+- [`agent_utils.py`](./agents/agent_utils.py) Formatting GameState and generation of valid actions
+- [`graph_agent_utils.py`](./agents/graph_agent_utils.py): GameState -> graph conversion
+- [`llm_utils.py`](./agents/llm_utils.py): utility functions for LLM-based agents
 
 ## Agents' compatibility with the environment
 
@@ -68,9 +70,6 @@ Additionally, there are several files with utils functions that can be used by a
 |[Random Defender](./agents/defenders/random/random_agent.py)| [main](https://github.com/stratosphereips/NetSecGame/tree/main) | | 👷🏼‍♀️ |
 |[Probabilistic Defender](./agents/defenders/probabilistic/probabilistic_agent.py)| [main](https://github.com/stratosphereips/NetSecGame/tree/main) | | 👷🏼‍♀️ |
 
-### Agent utils
-Utility functions in [agent_utils.py](./agents/agent_utils.py) can be used by any agent to evaluate a `GameState`, generate set of valid `Actions` in a `GameState` etc. 
-
 ## Export to mlflow
 
 Every agent by default exports the experiment details to a local mlflow directory.
@@ -88,6 +87,5 @@ If you want to export the local mlflow to a remote mlflow you can use our util
 python utils/export_import_mlflow_exp.py --experiment_id 783457873620024898 --run_id 5f2e4a205b7745259a4ddedc12d71a74 --remote_mlflow_url http://127.0.0.1:8000 --mlruns_dir ./mlruns
 ```
 
-
 ## About us
-This code was developed at the [Stratosphere Laboratory at the Czech Technical University in Prague](https://www.stratosphereips.org/) as part of the AIDojo Project.
+This code was developed at the [Stratosphere Laboratory at the Czech Technical University in Prague](https://www.stratosphereips.org/) as part of the [AIDojo Project](https://www.stratosphereips.org/ai-dojo).