Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris committed Sep 17, 2020
1 parent 1dcce0f commit d4acc49
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,13 @@ This action mainly consists of 5 parts: Data Collection, Preprocessing, Train mo

### Data Collection

All issues of the repository are collected in JSON format based on the `GitHub API`.
Issues include the title, body, and comments.
All issues of the repository are collected with the GitHub API.
The issues include the title, body, and comments.
Training Data is regularly collected using the scheduling function and output as an artifact and saved as a cache.

### Preprocessing

We convert markdown to text based on [unified].
The Markdown format is converted to plain text with [unified].
At this time, symbols that are not alphabetic characters are deleted.

- https://github.com/peaceiris/actions-suggest-related-links/blob/main/actions/src/preprocess.ts
Expand All @@ -146,6 +146,8 @@ Calculate word vectors of training data and word vectors of posted data in fastt

### Suggest Issues

![Suggest Related Links Action example result | peaceiris/actions-suggest-related-links](./images/example.jpg)

<div align="right"><a href="#table-of-contents">Back to TOC ☝️</a></div>


Expand Down

0 comments on commit d4acc49

Please sign in to comment.