add check and run to makefile and readme

eljandoubi · Aug 26, 2024 · 2b076f0 · 2b076f0
1 parent 5f811e3
commit 2b076f0
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -16,12 +16,21 @@ build:
 pytest:
 	. $(CONDA_BASE)/etc/profile.d/conda.sh && \
 	conda activate $(ENV_NAME) && \
-	pytest test_models.py
+	pytest test_code.py
 
 pylint:
 	. $(CONDA_BASE)/etc/profile.d/conda.sh && \
 	conda activate $(ENV_NAME) && \
 	pylint **/*.py
 
+check:
+	. $(CONDA_BASE)/etc/profile.d/conda.sh && \
+	conda activate $(ENV_NAME) && \
+	pylint **/*.py && \
+	pytest test_code.py
+
+run:
+	echo "The code is not completed yet."
+
 clean:
 	conda remove --name $(ENV_NAME) --all -y
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
     <a href="Pytest"><img src="https://img.shields.io/github/actions/workflow/status/eljandoubi/StableDiffusion/pytest-ci.yml?label=Pytest"></a>
 </p>
 
-Coding StableDiffusion from scratch using pytorch.
+Coding Stable Diffusion from scratch using pytorch.
 
 ## Setup environment
 * Clone the repository and Go to StableDiffusion directory.
@@ -24,8 +24,15 @@ git clone https://github.com/eljandoubi/StableDiffusion.git && cd StableDiffusio
 ```bash
 make build
 ```
-
-## Clean environment.
+## Check the code sanity
+```bash
+make check
+```
+## Run the pipeline
+```bash
+make run
+```
+## Clean environment
 ```bash
 make clean
 ```
diff --git a/test_models.py → test_code.py b/test_models.py → test_code.py