AlvaroMros commited on
Commit
4343b21
·
1 Parent(s): 55723a4

Modified Readme

Browse files
Files changed (1) hide show
  1. README.md +6 -10
README.md CHANGED
@@ -12,15 +12,17 @@ pinned: false
12
 
13
  [![Hugging Face Spaces](https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/AlvaroMros/ufc-predictor)
14
 
15
- Scrape ALL fight and fighter data from [ufcstats.com](http://ufcstats.com) up to the latest event and save them in `.csv` format
16
 
17
- How? Clone the repo, then open a terminal in the root folder and run the following commands:
18
 
19
  1. Install the required Python packages using pip:
20
 
21
  ```bash
22
  pip install -r requirements.txt
23
  ```
 
 
24
 
25
  2. Then run the main script to scrape all data:
26
 
@@ -29,16 +31,10 @@ python -m src.scrape.main
29
  ```
30
  This command will execute the entire scraping and processing pipeline, saving the final CSV files in the `output/` directory.
31
 
32
- 3. (Optional) Calculate fighter ELO ratings:
33
 
34
- ```bash
35
- python -m src.analysis.elo
36
- ```
37
- This updates `ufc_fighters.csv` with ELO scores and prints the top 10 fighters.
38
-
39
- 4. (Optional) Run the prediction pipeline:
40
 
41
  ```bash
42
  python -m src.predict.main
43
  ```
44
- This runs a baseline model to predict outcomes for the most recent fights and saves a detailed report in the `output/` directory.
 
12
 
13
  [![Hugging Face Spaces](https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/AlvaroMros/ufc-predictor)
14
 
15
+ ## Setup
16
 
17
+ Clone the repo, then open a terminal in the root folder and run the following commands:
18
 
19
  1. Install the required Python packages using pip:
20
 
21
  ```bash
22
  pip install -r requirements.txt
23
  ```
24
+ ## Scraping:
25
+ Scrape ALL fight and fighter data from [ufcstats.com](http://ufcstats.com) up to the latest event and save them in `.csv` format
26
 
27
  2. Then run the main script to scrape all data:
28
 
 
31
  ```
32
  This command will execute the entire scraping and processing pipeline, saving the final CSV files in the `output/` directory.
33
 
34
+ ## Train and save ML models:
35
 
36
+ This trains a different set of ML models and saves them in `output/models`.
 
 
 
 
 
37
 
38
  ```bash
39
  python -m src.predict.main
40
  ```