Skip to content

Commit de04d7a

Browse files
committed
[docs] update
1 parent 333e455 commit de04d7a

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@
1212
[![License](https://img.shields.io/github/license/bigdata-ustc/EduNLP)](LICENSE)
1313
[![DOI](https://zenodo.org/badge/332661206.svg)](https://zenodo.org/badge/latestdoi/332661206)
1414

15-
NLP tools for Educational data (e.g., exercise, papers)
1615

17-
## Introduction
1816
EduNLP is a library for advanced Natural Language Processing in Python and is one of the projects of EduX plan of BDAA. It's built on the very latest research, and was designed from day one to be used in real educational products.
1917

2018
EduNLP now comes with pretrained pipelines and currently supports segment, tokenization and vertorization. It supports varies of preprocessing for NLP in educational scenario, such as formula parsing, multi-modal segment.
2119

2220
EduNLP is commercial open-source software, released under the Apache-2.0 license.
2321

22+
## Quickstart
23+
2424
### Installation
2525

2626
Git and install by pip
@@ -40,16 +40,12 @@ pip install EduNLP
4040
pip install EduNLP[full]
4141
```
4242

43-
### Resource
44-
We will continously publish new datasets in [Standard Item Format (SIF)](https://github.com/bigdata-ustc/EduNLP/blob/master/docs/SIF4TI_CH.md) to encourage the relavant research works. The data resourses can be accessed via another EduX project [EduData](https://github.com/bigdata-ustc/EduData)
45-
4643
### Tutorial
4744

48-
* Overview (TBA)
49-
* [Formula Parsing](https://github.com/bigdata-ustc/EduNLP/blob/master/examples/formula/formula.ipynb)
50-
* [Segment and Tokenization](https://github.com/bigdata-ustc/EduNLP/blob/master/examples/sif/sif.ipynb)
51-
* [Vectorization](https://github.com/bigdata-ustc/EduNLP/tree/master/examples/pretrain)
52-
* Pretrained Model (TBA)
45+
For more details, please refer to the full documentation ([latest](https://edunlp.readthedocs.io/en/latest) | [stable](https://edunlp.readthedocs.io/en/stable)).
46+
47+
### Resource
48+
We will continously publish new datasets in [Standard Item Format (SIF)](https://github.com/bigdata-ustc/EduNLP/blob/master/docs/SIF4TI_CH.md) to encourage the relavant research works. The data resourses can be accessed via another EduX project [EduData](https://github.com/bigdata-ustc/EduData)
5349

5450
## Contribute
5551

0 commit comments

Comments
 (0)