Usage

<p>[TOC]</p> <p>Download QRec from GitHub. There are two ways to run QRec.</p> <h3>Run QRec with input</h3> <ol> <li> <p>Find the conf files the directory named config. Choose the model your want to configure and modify the settings (e.g. modify the dataset). <img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/db6ae2dcba996f434c4070fbdab4b74b" alt="conf" /></p> </li> <li> <p>run <code>python main.py</code> under the root directory. You will see the following prompt. <img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/e598d689bac75eda3a8b0e3eaef53de1" alt="main window" /></p> </li> <li> <p>Enter the number of the model you want to run (e.g. q2). <img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/5aa2980899adf570ab02c86165d1c077" alt="enternum" /></p> </li> <li> <h2>The chosen model will run like this. <img src="https://www.showdoc.com.cn/server/api/attachment/visitfile/sign/22e48687bb44407a8b9590357b0b826f" alt="modelrun" /> <br></h2> </li> </ol> <h3>Run QRec with embedded snippet</h3> <p>You can also use QRec in your program by embedding this snippet in your codes.</p> <pre><code class="language-python">#A snippet showing how to directly run algorithms in QRec from QRec import QRec #need to be modified according to your path from util.config import Config #need to be modified according to your path #----------------------------------------------------------------------------------- #create your own config file by following the file format in the directory of config #----------------------------------------------------------------------------------- config = Config("/home/xxx/algor_name.conf") rec = QRec(config) rec.execute() #----------------------------------------------------------------------------------- #your own codes to use the recommendation results #-----------------------------------------------------------------------------------</code></pre>