Merge pull request #194 from merveenoyan/main

Add doc-builder to the repo to add the course on HF

.github/workflows/build_documentation.yml

@@ -0,0 +1,20 @@
+name: Build documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main
+    with:
+      commit_sha: ${{ github.sha }}
+      package: computer-vision-course
+      package_name: computer-vision-course
+      repo_owner: johko
+      path_to_docs: computer-vision-course/chapters/
+      additional_args: --not_python_module
+      languages: en
+    secrets:
+      hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}

.github/workflows/build_pr_documentation.yml

@@ -0,0 +1,21 @@
+name: Build PR Documentation
+
+on:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@main
+    with:
+      commit_sha: ${{ github.event.pull_request.head.sha }}
+      pr_number: ${{ github.event.number }}
+      package: computer-vision-course
+      package_name: computer-vision-course
+      repo_owner: johko
+      path_to_docs: computer-vision-course/chapters/
+      additional_args: --not_python_module
+      languages: en

.github/workflows/quality.yml

@@ -0,0 +1,21 @@
+name: Quality checks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install Python dependencies
+      run: pip install black
+    - name: Run quality check
+      run: make quality

.github/workflows/upload_pr_documentation.yml

@@ -0,0 +1,17 @@
+name: Upload PR Documentation
+
+on:
+  workflow_run:
+    workflows: ["Build PR Documentation"]
+    types:
+      - completed
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/upload_pr_documentation.yml@main
+    with:
+      package_name: computer-vision-course
+      hub_base_path: https://moon-ci-docs.huggingface.co/learn
+    secrets:
+      hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
+      comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }}

chapters/en/_toctree.yml

@@ -36,7 +36,7 @@
     title: Introduction to Vision Language Models
   - local: Unit 4 - Multimodal Models/transfer_learning
     title: Transfer learning
-  - local: Unit 4 - Mulitmodal Models/supplementary-material
+  - local: Unit 4 - Multimodal Models/supplementary-material
     title: Supplemental reading and resources
 
 - title: Unit 5. Multimodal Models