avrs-web

AVRS Associated Videos Recommendation System

AVRS-web

An awesome Associated Videos Recommendation System!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

This App provides associated videos based on your selection as well as an interactive chart to visualize how videos are distributed by their topics.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Please make sure that all the necessary packages have been installed.

Prerequisites

Please install all the necessary packages before running the program. You may run either by setup.py or via pip install

• setup.py

  python setup.py install

You may also just install all the necessary package without install avrs-web as package.

• pip

  pip install -r requiement.txt

Installation

Here are the steps to follow to install avrs-web:

1. Clone the repo

   git clone https://github.com/yencli/avrs-web.git

2. Install packages

   python setup.py install

3. Enter your DB address in config.ini, you may left it blank if there's no specific folders for the files.

   DATA_DIR: 'ENTER YOUR DB ADDRESS';
   EMBED_FOLDER: 'ENTER FOLDER NAME FOR EMBEDDED DATA';
   RESULT_FOLDER: 'ENTER FOLDER NAME FOR CLUSTERING DATA';

4. Enter your filename in config.ini

   cid: 'ENTER YOUR FILENAME';

(back to top)

Usage

You may run on the example data provided here simply by executing the script run-app.py.

• run-app.py

  python tests/run-app.py

or you may try with your own data by configurating config.ini then run with:

• main.py

  python main.py

The documentation is distributed with avrs-web source code in the docs/ directory.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add pytest
• Add Documentation
• Add User-based data to content

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License V3. See LICENSE.txt for more information.

(back to top)

Contact

Yen C. Li - [email protected]

Project Link: https://github.com/yencli/avrs-web

(back to top)