bigdata-ustc / EduNLP

A library for advanced Natural Language Processing towards multi-modal educational items.
Apache License 2.0
51 stars 18 forks source link

[DOC] Restruct and Simplify the Docs #117

Closed KenelmQLH closed 2 years ago

KenelmQLH commented 2 years ago

Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below.

Description

The oneline docs url : https://qlh-edunlp.readthedocs.io/en/dev_docs/tutorial/zh/index.html

  1. Restruct and rename some files

    Especially clear the definition of sif 、seg 、 tokenize 、 tokenization、vectorization

  2. Simplify some Examples.
  3. Rectify some Examples.
  4. New Examples to add.

What does this implement/fix? Explain your changes.

...

Pull request type

Changes

Does this close any currently open issues?

...

Any relevant logs, error output, etc?

...

Checklist

Before you submit a pull request, please make sure you have to following:

Essentials

Comments

codecov-commenter commented 2 years ago

Codecov Report

Merging #117 (be0e671) into dev (31335a0) will decrease coverage by 0.21%. The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev     #117      +/-   ##
==========================================
- Coverage   98.18%   97.96%   -0.22%     
==========================================
  Files          66       66              
  Lines        3245     3245              
==========================================
- Hits         3186     3179       -7     
- Misses         59       66       +7     
Impacted Files Coverage Δ
EduNLP/Formula/Formula.py 100.00% <ø> (ø)
EduNLP/I2V/i2v.py 93.66% <ø> (-4.93%) :arrow_down:
EduNLP/Pretrain/bert_vec.py 100.00% <ø> (ø)
EduNLP/Pretrain/disenqnet_vec.py 100.00% <ø> (ø)
EduNLP/Pretrain/gensim_vec.py 100.00% <ø> (ø)
EduNLP/SIF/segment/segment.py 100.00% <ø> (ø)
EduNLP/SIF/tokenization/tokenization.py 100.00% <ø> (ø)
EduNLP/Tokenizer/tokenizer.py 100.00% <ø> (ø)
EduNLP/Vector/t2v.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 31335a0...be0e671. Read the comment docs.