This repository contains source code for Neureca💡 project. Neureca💡 is a framework for building conversational recommender (ConvRec) systems. It is also an open-source project that helps any ML researchers develop ConvRec system and contribute to key components easily. Neureca💡 is still under development stage.
pip install neureca
- Train NLU model(i.e. intent recognizer, item attribute recognizer) and Recommender model using your own dataset
neureca-train intent
neureca-train attribute
nuereca-train recommender
- Create main.py under your project directory
from pathlib import Path
from neureca import Neureca, NLU, Recommender, Explainer, Manager
from stages import greeting_stage
# load the latest trained version of each model if version is not speicfied in arguament
nlu = NLU()
recommender = Recommender()
explainer = Explainer()
dialogue_manager = Manager(initial_stage=greeting_stage)
#create neureca instance
neureca = Neureca(
nlu=nlu,
recommender=recommender,
explainer=explainer,
dialogue_manager=dialogue_manager,
path=Path.cwd(),
)
if __name__ == '__main__':
neureca.run(env="cli") # env: cli or web- Run neureca
python main.py
In addtion, Neureca supports web interface: neureca.run(env="web")
For more information, please visit docs.
Copyright 2021 Hojin Yang
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.