Skip to content

Commit

Permalink
edited readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Algoboy-Kevin committed Jul 31, 2024
1 parent c29cf29 commit 5bd3728
Showing 1 changed file with 8 additions and 28 deletions.
36 changes: 8 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,20 @@ This Python repository contains a testing environment and implementation of the
The Snake game is played on a 10x10 map. Each time the snake eats an apple, its length increases and the fitness score is incremented by 1. The goal is to achieve a fitness score of 20.

## Installation
To install the required dependencies, run the following command:

```
pip install -r requirements.txt
```
To install the required dependencies, run the following command`pip install -r requirements.txt`

## Usage
There are several options available for running the Snake game:
**Test Environment**: To test the environment, execute the following command:
```
python main.py test
```
**Train Snake**: To train the snake using the NEAT algorithm, use the following command:
```
python main.py train
```
**Save and Create Winner Model**: To save and create a winner model after training, run the following command:
```
python main.py save
```
**Run Trained Model**: To run a trained model, execute the following command:
```
python main.py run
```

**Run Master Model**: To run the master model, execute the following command:
```
python main.py run_master
```

Note: The last two commands are the same, but provided separately for clarity.
1. **Test Environment**: To test the environment, execute the following command: `python main.py test`
2. **Train Snake**: To train the snake using the NEAT algorithm, use the following command: `python main.py train`
3. **Save and Create Winner Model**: To save and create a winner model after training, run the following command: `python main.py save`
4. **Run Trained Model**: To run a trained model, execute the following command: `python main.py run`
5. **Run Master Model**: To run the master model, execute the following command: `python main.py run_master`

Note: The last two commands are the same, but provided separately for clarity.

## Contributors
- Snake env logic and network render reference. [Daniel Chang](https://github.com/danielchang2002)
- [Daniel Chang](https://github.com/danielchang2002) - Snake env logic and network render reference.

Feel free to contribute to this project by submitting pull requests or suggesting improvements. Happy coding!

1 comment on commit 5bd3728

@YoungDeveloper78
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@algoboy-kevin hi ,i reached out to you via email, but i'm not sure if you saw my message...
I'm looking for someone with your stack to work on our platform as a freelancer or full time . some projects start soon and others begin in 6 months ,so if you're busy now ,we can discuss it in advance . are you up ? contact me on telegram @shalavaleks or via email at [email protected]

Please sign in to comment.