Home

Welcome to the VNTK wiki!

VNTK is a toolkit and used in many simple applications which apply NLP (Natural Language Processing) techniques, especially Vietnamese.

• Documentation (vietnamese): https://vntk.yeu.ai/
• Chat for fun: https://gitter.im/vntk/Lobby

API Convention

Pre-trained model

• Use camelcase without parameters
• Example: var pos = require('vntk').posTag()

Custom re-trained model

• Use camelcase with a parameter as an input
• Example: var ner = require('vntk').ner('/path/to/custom/re-trained.model')

Utility class

• Initialize an instance with new operator
• Class are defined with upper camelcase
• Example: const fasttextClassifier = new vntk.FastTextClassifier(model)

Vntk-based chatbot framework

An easy way to create chatbots is to use vntk-chatbot-framework, in two ways:

1. Clone reposity vntk-chatbot-framework

git clone https://github.com/vntk/vntk-chatbot-framework my-chatbot
cd my-chatbot
npm install
npm run setup
npm start

2. Use NPM:

npm install @vntk/cli -g
vntk-chatbot create my-chatbot
cd my-chatbot
npm install
npm run setup
npm start