Merge pull request #7 from thewebscraping/feat/mk-docs

chore: mkdocs

Author: thewebscraping

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ on:
     branches: ['master', 'main', 'dev', 'develop']
 
 jobs:
-  build-on-ubuntu:
+  build:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 3
@@ -28,3 +28,26 @@ jobs:
         python -m black gemma_template
         python -m isort gemma_template
         python -m flake8 gemma_template
+
+  docs:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r requirements.txt
+      - run: mkdocs gh-deploy --force

docs/custom_templates/custom_template.md

@@ -0,0 +1,92 @@
+# Custom Templates to Vietnamese Language
+Gemma Template uses Jinja2 template.
+
+See also: [`models.Attr`](../../models/#attributes_5)
+
+* * *
+
+# Gemma Fine Tuning Template
+```text
+<start_of_turn>user
+{{ input }}<end_of_turn>
+<start_of_turn>model
+{{ output }}<end_of_turn>
+
+```
+
+* * *
+
+# Gemma Prompt Template
+```text
+<start_of_turn>user
+{{ input }}<end_of_turn>
+<start_of_turn>model
+
+```
+
+* * *
+
+# Input Template
+```text
+{{ system_prompt }}
+{% if instruction %}\n{{ instruction }}\n{% endif %}
+{% if prompt_structure %}{{ prompt_structure }}\n{% else %}{{ prompt }}\n{% endif %}
+# Văn Bản:
+{{ input }}
+{% if topic_value %}\nDanh Mục: {{ topic_value }}\n{% endif %}{% if keyword_value %}Từ Khoá: {{ keyword_value }}\n{% endif %}
+```
+
+* * *
+
+# Output Template
+```text
+{% if structure_fields %}{% for field in structure_fields %}## **{{ field.label.custom or field.label.default }}:**\n{% if field.key == 'title' %}### {% endif%}{{ field.value }}\n\n{% endfor %}{% else %}{{ output }}{% endif %}
+```
+
+* * *
+
+# Instruction Template
+```text
+# Vai trò:
+Bạn là một biên tập viên nội dung chuyên nghiệp, nhà phân tích ngôn ngữ và chuyên gia đa ngôn ngữ, chuyên về viết có cấu trúc và xử lý văn bản nâng cao.
+
+# Nhiệm Vụ:
+Mục tiêu chính của bạn là:
+1. Nhiệm vụ chính của bạn là viết lại nội dung được cung cấp theo định dạng có cấu trúc, chuyên nghiệp hơn, đồng thời vẫn giữ nguyên ý định và ý nghĩa ban đầu.
+2. Nâng cao khả năng hiểu từ vựng bằng cách phân tích văn bản với unigrams (từ đơn), bigrams (hai từ) và trigrams (ba từ).
+3. Đảm bảo phản hồi của bạn tuân thủ nghiêm ngặt định dạng cấu trúc được quy định.
+4. Phản hồi bằng ngôn ngữ chính của văn bản đầu vào trừ khi có hướng dẫn thay thế rõ ràng.
+
+# Kỳ Vọng Bổ Sung:
+1. Cung cấp phiên bản văn bản đầu vào được viết lại, nâng cao, đảm bảo tính chuyên nghiệp, rõ ràng và cấu trúc được cải thiện.
+2. Tập trung vào khả năng đa ngôn ngữ, sử dụng vốn từ vựng phức tạp, ngữ pháp để cải thiện phản hồi của bạn.
+3. Giữ nguyên ngữ cảnh và sắc thái văn hóa của văn bản gốc khi viết lại.
+{% if topic_value %}\nTopics: {{ topic_value }}\n{% endif %}{% if keyword_value %}Keywords: {{ keyword_value }}\n{% endif %}
+
+# Phân Tích Văn Bản:
+Ví Dụ 1: Unigrams (nhóm 1 chữ cái){% for word in unigrams %}\n{{ word }} => Tiếng Việt ({{ language }}){% endfor %}
+
+Phân Tích Văn Bản 1: đây là những từ thông dụng trong tiếng Việt ({{ language }}), cho biết văn bản được viết bằng tiếng Việt ({{ language }}).
+
+Ví Dụ 2: Bigrams (nhóm 2 chữ cái){% for word in bigrams %}\n{{ word }} => Tiếng Việt ({{ language }}){% endfor %}
+Phân Tích Văn Bản 2: các từ ghép thường gặp trong Tiếng Việt ({{ language }}) xác nhận bối cảnh ngôn ngữ.
+
+Ví Dụ 3: Trigrams (nhóm 3 chữ cái)\n{% for word in trigrams %}{{ word }} => Tiếng Việt ({{ language }}){% endfor %}
+Phân Tích Văn Bản 3: các từ ghép 3 chữ liên tiếp là những từ tiếng Việt sử dụng thường xuyên, xác nhận sự cần thiết phải phản hồi bằng Tiếng Việt ({{ language }}).
+
+# Kết Luận Phân Tích Văn Bản:
+Phân tích ngôn ngữ xác nhận văn bản chủ yếu bằng Tiếng Việt ({{ language }}). Do đó, phản hồi phải được cấu trúc và viết bằng Tiếng Việt ({{ language }}). để phù hợp với văn bản và ngữ cảnh gốc.
+```
+
+* * *
+
+# Prompt Template
+```text
+{% if prompt %}\n\n# Đầu Vào Văn Bản:\n{{ prompt }}\n\n{% endif %}{% if structure_fields %}# Định Dạng Cấu Trúc Phản Hồi:
+Bạn phải tuân theo cấu trúc phản hồi:
+
+{% for field in structure_fields %}{{ field.label }}\n{% endfor %}
+
+Bằng cách tuân thủ định dạng này, phản hồi sẽ duy trì tính toàn vẹn về mặt ngôn ngữ đồng thời tăng cường tính chuyên nghiệp, cấu trúc và sự phù hợp với mong đợi của người dùng.
+{% endif %}
+```

docs/custom_templates/default_template.md

@@ -0,0 +1,89 @@
+# Default Templates
+Gemma Template uses Jinja2 template.
+
+See also: [`models.Attr`](../../models/#attributes_5)
+
+* * *
+
+# Gemma Fine Tuning Template
+```text
+<start_of_turn>user
+{{ input }}<end_of_turn>
+<start_of_turn>model
+{{ output }}<end_of_turn>
+
+```
+
+* * *
+
+# Gemma Prompt Template
+```text
+<start_of_turn>user
+{{ input }}<end_of_turn>
+<start_of_turn>model
+
+```
+
+* * *
+
+# Input Template
+```text
+{{ system_prompt }}
+{% if instruction %}\n{{ instruction }}\n{% endif %}
+{% if prompt_structure %}{{ prompt_structure }}\n{% else %}{{ prompt }}\n{% endif %}
+# Text:
+{{ input }}
+{% if topic_value %}\nTopics: {{ topic_value }}\n{% endif %}{% if keyword_value %}Keywords: {{ keyword_value }}\n{% endif %}
+```
+
+* * *
+
+# Output Template
+```text
+{% if structure_fields %}{% for field in structure_fields %}## **{{ field.label.custom or field.label.default }}:**\n{% if field.key == 'title' %}### {% endif%}{{ field.value }}\n\n{% endfor %}{% else %}{{ output }}{% endif %}
+```
+
+* * *
+
+# Instruction Template
+```text
+# Role:
+You are a highly skilled professional content writer, linguistic analyst, and multilingual expert specializing in structured writing and advanced text processing.
+
+# Task:
+Your primary objectives are:
+1. Simplification: Rewrite the input text or document to ensure it is accessible and easy to understand for a general audience while preserving the original meaning and essential details.
+2. Lexical and Grammatical Analysis: Analyze and refine vocabulary and grammar using unigrams (single words), bigrams (two words), and trigrams (three words) to enhance readability and depth.
+3. Structure and Organization: Ensure your response adheres strictly to the prescribed structure format.
+4. Language Consistency: Respond in the same language as the input text unless explicitly directed otherwise.
+
+# Additional Guidelines:
+1. Provide a rewritten, enhanced version of the input text, ensuring professionalism, clarity, and improved structure.
+2. Focus on multilingual proficiency, using complex vocabulary, grammar to improve your responses.
+3. Preserve the context and cultural nuances of the original text when rewriting.
+
+# Text Analysis:
+Example 1: Unigrams (single words){% for word in unigrams %}\n{{ word }} => {{ language }}{% endfor %}
+Text Analysis 3: These are common {{ language }} words, indicating the text is in {{ language }}.
+
+Example 2: Bigrams (two words){% for word in bigrams %}\n{{ word }} => {{ language }}{% endfor %}
+Text Analysis 2: Frequent bigrams in {{ language }} confirm the language context.
+
+Example 3: Trigrams (three words){% for word in trigrams %}\n{{ word }} => {{ language }}{% endfor %}
+Text Analysis 3: Trigrams further validate the linguistic analysis and the necessity to respond in {{ language }}.
+
+# Conclusion of Text Analysis:
+The linguistic analysis confirms the text is predominantly in {{ language }}. Consequently, the response should be structured and written in {{ language }} to align with the original text and context.
+```
+
+* * *
+
+# Prompt Template
+```text
+{% if prompt %}\n\n# Input Text:\n{{ prompt }}\n\n{% endif %}{% if structure_fields %}# Response Structure Format:
+You must follow the response structure:
+
+{% for field in structure_fields %}{{ field.label }}\n{% endfor %}
+By adhering to this format, the response will maintain linguistic integrity while enhancing professionalism, structure and alignment with user expectations.\n
+{% endif %}
+```