junte/Model
1
0
Fork 0
mirror of https://github.com/Hestia-Homes/Model.git synced 2026-06-30 13:10:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add extra steps to readme and makefile

Browse source
This commit is contained in:
Michael Duong 2023-08-29 18:16:46 +01:00
parent b2f606055f
commit 469938bb25
2 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
model_data/simulation_system/Makefile
View file

@ -13,8 +13,13 @@ env:
. .training_env/bin/activate . .training_env/bin/activate
pip install --upgrade pip pip install --upgrade pip
pip install -r requirements/training/training-dev.txt && pre-commit install pip install -r requirements/training/training-dev.txt && pre-commit install
echo " --- TO ACTIVATE THE ENVIRONMENT --- "
echo "Run source .training_env/bin/activate to activate the virtual environment" echo "Run source .training_env/bin/activate to activate the virtual environment"
.PHONY: check-all
check-all: pre-commit run -a
.PHONY: build .PHONY: build
build: build:
docker-compose build docker-compose build

11
model_data/simulation_system/README.md
View file

@ -3,6 +3,13 @@
Starter Readme: Starter Readme:
Steps for pipeline: Steps for pipeline:
- (WIP) Set up the training development environment
- Change directory to this folder (simulation_system)
- Run the following command `make env PYTHON_VERSION=3.10.12`
- This will install the specified python version using `pyenv` and select this version as the global python version
- It will install all training packages as specified in the training-dev.txt requirements file, including the pre-commit hooks
- Run `source .training_env/bin/activate` to use this environment
- (WIP) Use Makefile to start up mock up s3 service - (WIP) Use Makefile to start up mock up s3 service
- By running `make init`, this will run the `docker-compose build` and `docker-compose up -d`, which spins up a S3 service - By running `make init`, this will run the `docker-compose build` and `docker-compose up -d`, which spins up a S3 service
- This docker compose is running in detached mode `-d`, so will no output anything to the terminal - This docker compose is running in detached mode `-d`, so will no output anything to the terminal
@ -57,6 +64,10 @@ Steps for pipeline:
- Sort out local mock up services - Sort out local mock up services
- Sort out Model Registry - Sort out Model Registry
- Sort out Data version control - Sort out Data version control
- pre-commit hooks:
- The types of hooks that we want (safety, bandit, iso8 etc)
- The customisations we require
- Add sphinx documentation
- Data Science: - Data Science:
- Implement a metrics class, to hold all metric - Implement a metrics class, to hold all metric
- Rebuild metrics script (Could be a one off but good to have) - Rebuild metrics script (Could be a one off but good to have)