https://github.com/hellsan631/pippo

A CTR CLI tool for pippo
https://github.com/hellsan631/pippo

Last synced: 9 days ago
JSON representation

A CTR CLI tool for pippo

• Host: GitHub
• URL: https://github.com/hellsan631/pippo
• Owner: hellsan631
• Created: 2015-11-21T07:07:56.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-26T23:56:53.000Z (about 9 years ago)
• Last Synced: 2024-11-08T11:06:21.070Z (2 months ago)
• Language: JavaScript
• Size: 29.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pippo

> A CTR CLI tool for pippo

[![Build Status](https://travis-ci.org/hellsan631/Pippo.svg?branch=master)](https://travis-ci.org/hellsan631/Pippo) [![Coverage Status](https://coveralls.io/repos/hellsan631/Pippo/badge.svg?branch=master&service=github)](https://coveralls.io/github/hellsan631/Pippo?branch=master)

### CLI Installation and Useage

First, install pippo globally:

```shell

npm install -g pippo

```

This will install the ```resol``` command into your shell. Next run the pippo command with two local files

```shell

$ resol ./path/to/advertisers.txt ./path/to/people.txt

```

This will generate optimized CTR choices and display them in console. If you want to save the output to a file, then use the -o option in the command line

```shell

$ resol ./path/to/advertisers.txt ./path/to/people.txt -o output.txt

```

Or if you want to just test it out without needing the txt files, you can add in the -t option

```shell

$ resol -t

```

If you want to see what it can do, just type resol, or resol -h for all the options

```shell

$ resol

$ resol -h

```

### Programatic Useage

If you want to use the Resol library locally in an NPM server or in the browser, then just use npm to install it normally

```shell

npm install pippo --save

```

And include it in your scripts using the require function (requires browserify if your using a browser)

```js

var Resol = require('pippo');

var ctr     = new Resol(advertiserArray, peopleArray);

var results = ctr.pareto();

/* Results:

  {

    choices: [

      {

        ad: "Advertiser Name",

        person: "Person Name",

        score: 15,

        cost: -20

      }

    ],

    score: 15

  }

 */

```