Alvaro commited on
Commit
69835b6
·
1 Parent(s): 38c6a34

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -5
README.md CHANGED
@@ -1,18 +1,32 @@
1
- # UFC Scraper
2
 
3
  Scrape ALL fight and fighter data from [ufcstats.com](http://ufcstats.com) up to the latest event and save them in `.csv` format
4
 
5
  How? Clone the repo, then open a terminal in the root folder and run the following commands:
6
 
7
- 1. install the required Python packages using pip:
8
 
9
  ```bash
10
  pip install -r requirements.txt
11
  ```
12
 
13
- 2. Then run the main script:
14
 
15
  ```bash
16
- python src/scrape/main.py
17
  ```
18
- This command will execute the entire scraping process and save the final CSV files in the `output/` directory.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # UFC Scraper & ML
2
 
3
  Scrape ALL fight and fighter data from [ufcstats.com](http://ufcstats.com) up to the latest event and save them in `.csv` format
4
 
5
  How? Clone the repo, then open a terminal in the root folder and run the following commands:
6
 
7
+ 1. Install the required Python packages using pip:
8
 
9
  ```bash
10
  pip install -r requirements.txt
11
  ```
12
 
13
+ 2. Then run the main script to scrape all data:
14
 
15
  ```bash
16
+ python -m src.scrape.main
17
  ```
18
+ This command will execute the entire scraping and processing pipeline, saving the final CSV files in the `output/` directory.
19
+
20
+ 3. (Optional) Calculate fighter ELO ratings:
21
+
22
+ ```bash
23
+ python -m src.analysis.elo
24
+ ```
25
+ This updates `ufc_fighters.csv` with ELO scores and prints the top 10 fighters.
26
+
27
+ 4. (Optional) Run the prediction pipeline:
28
+
29
+ ```bash
30
+ python -m src.predict.main
31
+ ```
32
+ This runs a baseline model to predict outcomes for the most recent fights and saves a detailed report in the `output/` directory.