Skip to content

Commit

Permalink
Revise documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hankcs committed Feb 8, 2022
1 parent ffdf1ec commit 9e5de0a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/api/common/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# hanlp_common

Common API shared between `hanlp` and `restful`.
Common APIs shared between `hanlp` and `restful`.

```{toctree}
document
Expand Down
8 changes: 3 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,6 @@ If your server has no Internet access at all, just debug your codes on your loca
1. `~/.hanlp`: the home directory for HanLP models.
1. `~/.cache/huggingface`: the home directory for Hugging Face 🤗 Transformers.

````{margin} **Thirdparty Versions**
```{danger}
NEVER install TensorFlow/fastText by yourself, as higher or lower versions of TensorFlow have not been tested and might not work properly.
```
````

### Import Error

Expand All @@ -108,3 +103,6 @@ Some TensorFlow/fastText models will ask you to install the missing TensorFlow/f
pip install hanlp[full]
```

```{danger}
NEVER install thirdparty packages (TensorFlow/fastText etc.) by yourself, as higher or lower versions of thirparty packages have not been tested and might not work properly.
```

0 comments on commit 9e5de0a

Please sign in to comment.