Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
RihabFekii committed Apr 10, 2023
1 parent a3874c0 commit c8dda7d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ env:
@echo ">>> A new virtual env is created. Activate it with:\nsource env/bin/activate ."


requirements:
@echo ">>> Installing project requirements"
$(PYTHON_INTERPRETER) -m pip install -r requirements.txt

mlflow:
@echo ">>> Authenticating to MLflow remote server on DagsHub"
export MLFLOW_TRACKING_URI=$(MLFLOW_TRACKING_URI)
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,25 @@ git clone https://github.com/RihabFekii/
make env
source env/bin/activate .
````

3. Install requirements, by running this command:
````shell
make requirements
`````
## Run experiments with DVC
1. You can experiment with the different models of YOLOv8 and edit its hyperparameters
by editing the [params.yaml](/params.yaml) file.
2. Since the data pipeline is created with dvc, you can easily reproduce experiments by runing:
````sell
dvc exp run
`````
3. Visualize experiments by running:
````
dvc exp show
`````


0 comments on commit c8dda7d

Please sign in to comment.