Draichi commited on
Commit
8e1b7e2
1 Parent(s): 5f55c1f

docs: add environment documentation

Browse files
Files changed (3) hide show
  1. .gitignore +2 -0
  2. README.md +6 -21
  3. environment.yml +12 -0
.gitignore ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+ /.ipynb_checkpoints
2
+ .env
README.md CHANGED
@@ -40,37 +40,22 @@ Ensure you have Python installed (version 3.9).
40
 
41
  ```sh
42
  # Using Conda (recommended)
43
- conda create -n fastf1-predictions python=3.9
44
-
45
- # Using venv
46
- python -m venv venv
47
- source venv/bin/activate # On Windows, use `venv\Scripts\activate`
48
- ```
49
-
50
- 3. Install the required dependencies:
51
- ```sh
52
- pip install -r requirements.txt
53
- ```
54
 
55
  ### Running the Notebook
56
 
57
- 1. Navigate to the `notebooks` directory:
58
-
59
- ```sh
60
- cd notebooks
61
- ```
62
-
63
- 2. Launch Jupyter Notebook:
64
 
65
  ```sh
66
- jupyter notebook
67
  ```
68
 
69
- 3. Open `sector-3-time-prediction.ipynb` and run the cells to see the lap time prediction in action.
70
 
71
  ## Vision for the Future
72
 
73
- The potential for FastF1 Predictions is immense. As we continue to gather more data and refine our models, we aim to incorporate additional data sources such as weather conditions. Moreover, we plan to explore advanced modeling techniques, including deep learning and reinforcement learning methods, to further enhance prediction accuracy.
74
 
75
  Stay tuned for updates, and thank you for your support!
76
 
 
40
 
41
  ```sh
42
  # Using Conda (recommended)
43
+ conda env create --file environment.yml
44
+ ```
 
 
 
 
 
 
 
 
 
45
 
46
  ### Running the Notebook
47
 
48
+ 1. Launch Jupyter Notebook:
 
 
 
 
 
 
49
 
50
  ```sh
51
+ jupyter
52
  ```
53
 
54
+ 2. Open `sector-3-time-prediction.ipynb` and run the cells to see the lap time prediction in action.
55
 
56
  ## Vision for the Future
57
 
58
+ The potential for FastF1 Predictions is immense. As we continue to gather more data and refine our models, we aim to incorporate additional data sources such as weather conditions. Moreover, we plan to explore advanced modeling techniques, including deep learning, Agent LLM and reinforcement learning methods, to further enhance prediction accuracy.
59
 
60
  Stay tuned for updates, and thank you for your support!
61
 
environment.yml ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: fastf1-predictions
2
+ channels:
3
+ - conda-forge
4
+ dependencies:
5
+ - python=3.9
6
+ - ipykernel
7
+ - pandas
8
+ - jupyterlab
9
+ - plotly
10
+ - fastf1
11
+ - pip:
12
+ - ydf