Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sir-kokabi committed Jul 30, 2023
1 parent 2ba24d1 commit 36abb01
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 7 deletions.
8 changes: 8 additions & 0 deletions documentation/content/hazm/embedding.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
??? info "کاربرد عملی"

برای آشنایی با کاربرد این ماژول می‌توانید به بخش کاربردهای هضم مراجعه کنید.

در پروژه‌های زیر از این ماژول استفاده شده است:

- [پروژهٔ استخراج کلمات کلیدی](../samples/keyword_extraction.html)

::: hazm.embedding
10 changes: 9 additions & 1 deletion documentation/content/hazm/normalizer.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
::: hazm.normalizer
??? info "کاربرد عملی"

برای آشنایی با کاربرد این ماژول می‌توانید به بخش کاربردهای هضم مراجعه کنید.

در پروژه‌های زیر از این ماژول استفاده شده است:

- [پروژهٔ استخراج کلمات کلیدی](../samples/keyword_extraction.html)

::: hazm.normalizer
8 changes: 8 additions & 0 deletions documentation/content/hazm/pos_tagger.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
??? info "کاربرد عملی"

برای آشنایی با کاربرد این ماژول می‌توانید به بخش کاربردهای هضم مراجعه کنید.

در پروژه‌های زیر از این ماژول استفاده شده است:

- [پروژهٔ استخراج کلمات کلیدی](../samples/keyword_extraction.html)

::: hazm.pos_tagger.POSTagger
8 changes: 8 additions & 0 deletions documentation/content/hazm/sentence_tokenizer.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
??? info "کاربرد عملی"

برای آشنایی با کاربرد این ماژول می‌توانید به بخش کاربردهای هضم مراجعه کنید.

در پروژه‌های زیر از این ماژول استفاده شده است:

- [پروژهٔ استخراج کلمات کلیدی](../samples/keyword_extraction.html)

::: hazm.sentence_tokenizer
8 changes: 8 additions & 0 deletions documentation/content/hazm/word_tokenizer.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
??? info "کاربرد عملی"

برای آشنایی عملی با کاربرد این ماژول می‌توانید به بخش کاربردهای هضم مراجعه کنید.

در پروژه‌های زیر از این ماژول استفاده شده است:

[پروژهٔ استخراج کلمات کلیدی](../samples/keyword_extraction.html)

::: hazm.word_tokenizer
7 changes: 7 additions & 0 deletions documentation/content/samples/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# کاربردهای هضم

در این بخش مثال‌هایی عملی از کاربردهای هضم در سناریوهای مختلف قرار گرفته است. شما نیز می‌توانید مثال‌های خودتان را اضافه کنید.

## فهرست مثال‌ها:

### [استخراج کلمات کلیدی](./keyword_extraction.md)
2 changes: 1 addition & 1 deletion documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
$ pip install hazm
```

سپس [منابع موردنظر را دانلود کنید](https://github.com/roshan-research/hazm#pretrained-models) و ترجیحاً در ریشهٔ پروژهٔ خود اکسترکت کنید.
سپس [منابع موردنظر را دانلود کنید](https://github.com/roshan-research/hazm#pretrained-models) و ترجیحاً در ریشهٔ پروژه اکسترکت کنید.

و در آخر، هضم را را در پروژه خود ایمپورت کنید:

Expand Down
11 changes: 6 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@
site_name: هضم | کتابخانهٔ پردازش زبان فارسی
site_description: کتابخانه‌ای پایتونی برای پردازش زبان فارسی
site_author: روشن
site_url: https://roshan-research.github.io
site_url: https://www.roshan-ai.ir/hazm/
repo_url: https://github.com/roshan-research/hazm

remote_branch: master
repo_name: hazm
edit_uri: edit/master/documentation

docs_dir: documentation
site_dir: docs/docs

copyright: |
کپی‌رایت &copy; ۱۴۰۰ - ۱۴۰۱ <a href="https://github.com/roshan-research/hazm" target="_blank" rel="noopener">روشن</a> &nbsp;|&nbsp;
کپی‌رایت &copy; ۱۴۰۱ - ۱۴۰۲ <a href="https://github.com/roshan-research/hazm" target="_blank" rel="noopener">روشن</a> &nbsp;|&nbsp;
<a href="#__consent">تغییر تنظیمات کوکی</a>
theme:
Expand Down Expand Up @@ -52,6 +51,7 @@ theme:
- content.tooltips
- content.code.annotate
- content.code.copy
- content.code.select

plugins:
- autorefs
Expand Down Expand Up @@ -106,6 +106,7 @@ nav:
- verbvalency_reader: content/hazm/corpus_readers/verbvalency_reader.md
- Wikipedia_reader: content/hazm/corpus_readers/wikipedia_reader.md
- کاربردهای هضم:
- content/samples/index.md
- استخراج کلمات کلیدی: content/samples/keyword_extraction.md

- سایر بخش‌ها:
Expand All @@ -114,13 +115,13 @@ nav:
extra:
analytics:
provider: google
property: G-D32414H137
property: G-D32414H137

repo_url: https://github.com/roshan-research/hazm
consent:
title: درخواست استفاده از کوکی
description: >-
با پذیرش کوکی به ما اجازه می‌دهید تا با بررسی تعامل شما با سایت و شناسایی بازدیدهای بعدی‌‌تان، کیفیت مستندات را بهبود بخشیم.
با پذیرش کوکی به ما اجازه می‌دهید تا با بررسی تعامل شما با سایت و شناسایی بازدیدهای بعدی‌‌تان، کیفیت مستندات را بهبود ببخشیم.
<br>
سپاس از همکاری شما. ❤️
Expand Down

0 comments on commit 36abb01

Please sign in to comment.