Update README to include instructions to set HUgging Face repo

README.md

@@ -6,64 +6,88 @@ Set the Cookiecutter-MLOps in Hugging Face
 ==============================================
 
  1. Create Model repository in Hugging Face (e.g. myHFrepo)
- 2. In your local directory run:
+ 2. Clone your Hugging face repo to your local directory:
 	
-'''bash
-cd /path/to/parent directory of project folder
-git clone git@hf.co:USERNAME/myHFrepo
-'''
+	cd /path/to/parent directory of project folder
+	git clone git@hf.co:USERNAME/myHFrepo
+	
+   For ssh connection check [here](https://huggingface.co/docs/hub/security-git-ssh#add-a-ssh-key-to-your-account)
+
+ 3. Create your virtual environment (e.g. jointvenv) 
 	
-	For ssh connection check here
 	cd myHFrepo
 	python -m venv jointvenv
-
 	source jointvenv/bin/activate
 
-
-Follow instructions on DagsHub/Cookiecutter-MLOps | DagsHub
+ 4. Transfer and set DagsHub's cookiecutter template employing MLOps best practices to your Huggingface repo
+	
 	git clone https://dagshub.com/DagsHub/Cookiecutter-MLOps.git
+	
+ 4.1 Delete git files cloned from Cookiecutter-MLOps repo
+	
 	rm -r /path/to/myHFrepo/Cookiecutter-MLOps/.git
+
+ 4.2 dResolve conflicts with .gitattributes and README.md
+
 	cat /path/to/myHFrepo/Cookiecutter-MLOps/.gitattributes >> /path/to/myHFrepo/.gitattributes
 	rm /path/to/myHFrepo/Cookiecutter-MLOps/.gitattributes
-	cat /path/to/myHFrepo/Cookiecutter-MLOps/README >> /path/to/myHFrepo/README
-	rm /path/to/myHFrepo/Cookiecutter-MLOps/README
-	git add README.md
-	git commit -m "Paste README info from DagsHub/Cookiecutter-MLOps"
 	git add .gitattributes
 	git commit -m "Paste .gitattributes info from DagsHub/Cookiecutter-MLOps"
-cd /path/to/myHFrepo/Cookiecutter-MLOps
-mv * .[^.]* ..
-cd /path/to/myHFrepo
+	
+	cat /path/to/myHFrepo/Cookiecutter-MLOps/README.md >> /path/to/myHFrepo/README.md
+	rm /path/to/myHFrepo/Cookiecutter-MLOps/README.md
+	git add README.md
+	git commit -m "Paste README info from DagsHub/Cookiecutter-MLOps"
+	
+ 4.3 Move remaining files from DagsHub/Cookiecutter-MLOps yo your Hugging Face repo .gitattributes and README.md
+
+	cd /path/to/myHFrepo/Cookiecutter-MLOps
+	mv * .[^.]* ..
+	cd /path/to/myHFrepo
 	rm -r /path/to/myHFrepo/Cookiecutter-MLOps
+
+ 5. Add venv folder to.gitignore
+
 	echo '' >> .gitignore
 	echo '#'Virtual Environment >> .gitignore
-echo jointvenv/ >> .gitignore
+	echo jointvenv/ >> .gitignore
 	git add .
 	git commit -m "add remaining DagsHub/Cookiecutter-MLOps repo content"
+
+ 6. Run step 2 from DagsHub/Cookiecutter-MLOps
+
 	make dirs
-make requirements
-mv requirements.txt requirementsCookiecutter-MLOps.txt
-git add requirementsCookiecutter-MLOps.txt
-git commit -m "external requirements from Cookiecutter-
-MLOps"
-pip freeze > requirements.txt
-git add requirements.txt
-git commit -m "First report venv requirements"
-git push origin main
-
- Create Model repository in your Hugging Face organization (e.g. myHFrepo)
-
-git remote add dcc git@hf.co:MYORG/mywslHFrepo
-git pull dcc main --allow-unrelated-histories
-Resolve conflicts in .gitattributes and README.md
-git add .
-git commit -m "Merge HuggingFace individual and organization repos"
-git push dcc main
 
+ 7. Run step 4 from DagsHub/Cookiecutter-MLOps
+	
+	make requirements
+
+ 8. Keep record of your own requirements
+ 
+	mv requirements.txt requirementsCookiecutter-MLOps.txt
+	git add requirementsCookiecutter-MLOps.txt
+	git commit -m "external requirements from Cookiecutter-MLOps"
 
+	pip freeze > requirements.txt
+	git add requirements.txt
+	git commit -m "First report venv requirements"
 
+ 9. Push your changes to the remote Hugging face repository
 
+	git push origin main
 
+ 10. Optional Create Model repository in your Hugging Face organization (e.g. myHFrepo)
+
+	git remote add dcc git@hf.co:MYORG/mywslHFrepo
+	git pull dcc main --allow-unrelated-histories
+
+Resolve conflicts in .gitattributes and README.md
+	
+	git add .
+	git commit -m "Merge HuggingFace individual and organization repos"
+	git push dcc main
+
+==============================
 Cookiecutter-MLOps
 ==============================