initial setup

.github/workflows/mk.yml

@@ -0,0 +1,16 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - master
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

docs/index.md

@@ -0,0 +1,34 @@
+# dvc-project-template
+DVC project template
+
+## STEPS -
+
+### STEP 01- Create a repository by using template repository
+
+### STEP 02- Clone the new repository
+
+### STEP 03- Create a conda environment after opening the repository in VSCODE
+
+```bash
+conda create --prefix ./env python=3.7 -y
+```
+
+```bash
+conda activate ./env
+```
+OR
+```bash
+source activate ./env
+```
+
+### STEP 04- install the requirements
+```bash
+pip install -r requirements.txt
+```
+
+### STEP 05- initialize the dvc project
+```bash
+dvc init
+```
+
+### STEP 06- commit and push the changes to the remote repository

docs/javascripts/mathjax.js

@@ -0,0 +1,17 @@
+window.MathJax = {
+    tex: {
+      inlineMath: [["\\(", "\\)"]],
+      displayMath: [["\\[", "\\]"]],
+      processEscapes: true,
+      processEnvironments: true
+    },
+    options: {
+      ignoreHtmlClass: ".*|",
+      processHtmlClass: "arithmatex"
+    }
+  };
+  
+  document$.subscribe(() => {
+    MathJax.typesetPromise()
+  })
+  

mkdocs.yml

@@ -0,0 +1,73 @@
+# Project information
+site_name: REPO_NAME_OR_SITE_NAME
+# defeine TOC or order of website-
+nav:
+  - Home: index.md
+
+site_author: Shivansh Kaushal
+site_description: >-
+  DESCRIPTION
+
+# Repository
+repo_name: shivanshka/REPO_NAME
+repo_url: https://github.com/shivanshka/REPO_NAME
+
+# Configuration
+theme:
+  name: material
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - navigation.top
+  language: en
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/toggle-switch-off-outline 
+        name: Switch to dark mode
+      primary: teal
+      accent: purple 
+    - scheme: slate 
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode    
+      primary: teal
+      accent: lime    
+  # logo: PyTorch_logo_icon.svg
+  
+extra:
+  social:
+    - icon: fontawesome/brands/github-alt
+      link: https://github.com/shivanshka
+    #- icon: fontawesome/brands/twitter
+    #  link: https://twitter.com/c17hawke
+    - icon: fontawesome/brands/linkedin
+      link: https://linkedin.com/in/shivansh-ka
+    #- icon: fontawesome/brands/instagram
+    #  link: https://www.instagram.com/c17hawke/
+
+extra_javascript:
+  - javascripts/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js #?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - admonition
+  - pymdownx.arithmatex:
+      generic: true
+  - footnotes
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.mark
+  
+  
+plugins:
+  - search
+
+copyright: |
+  &copy; 2022 <a href="https://github.com/shivanshka"  target="_blank" rel="noopener">Shivansh Kaushal</a>

requirements.txt

@@ -0,0 +1,7 @@
+numpy
+pandas
+tensorflow
+transformers[sentencepiece]
+streamlit
+matplotlib
+seaborn