chore: app only

rafaelkallis · Nov 27, 2022 · d548eda · d548eda
1 parent c39083a
commit d548eda
Show file tree

Hide file tree

Showing 18 changed files with 45 additions and 716 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ Ticket Tagger is licensed under the GNU Affero General Public License. Every fil
 
 ```
 Ticket Tagger automatically predicts and labels issue types.
-Copyright (C) 2018-2021  Rafael Kallis
+Copyright (C) 2018-2023  Rafael Kallis
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
@@ -41,6 +41,7 @@ Carefully read the [full license agreement](https://www.gnu.org/licenses/agpl-3.
 > "... [The AGPL-3.0 license] requires the operator of a network server to provide the source code of the modified version running there to the users of that server."
 
 ### Derivative Work
+
 - [BEE](https://github.com/sea-lab-wm/bee-tool), Yang Song and Oscar Chaparro
 - [Github Issue Classification Evaluation](https://github.com/ChristianBirchler/ticket-tagger-analysis), Tim Moser, David Steiger, Christian Birchler, Lara Fried, Sebastiano Panichella, Rafael Kallis
 
@@ -53,28 +54,17 @@ Carefully read the [full license agreement](https://www.gnu.org/licenses/agpl-3.
 
 #### notice:
 
-- nodejs `^12.x` is required to compile/install dependencies
-- `wget` is required for fetching datasets
-- we recommend at least 8 GB of RAM if you want to train or benchmark the model
+- nodejs is required to compile/install dependencies
 
 #### get started:
 
 ```sh
 git clone https://github.com/rafaelkallis/ticket-tagger ticket-tagger
 cd ticket-tagger
 
-# install appropriate nodejs version
-npx nave use 12
-
 # compile/install dependencies
 npm install
 
-# fetch dataset
-npm run dataset
-
-# run benchmark
-npm run benchmark
-
 # run linter
 npm run lint
 
@@ -84,90 +74,3 @@ npm test
 # run server
 NODE_ENV="development" npm start
 ```
-
-#### confounding factors:
-
-> Impact of Label Distribution
-
-```sh
-# balanced distribution
-npm run dataset:balanced
-npm run benchmark
-
-# unbalanced distribution
-npm run dataset:unbalanced
-npm run benchmark
-```
-
-> Impact of function words
-
-```sh
-npm run dataset:balanced
-npm run benchmark
-```
-
-> Impact of Language Consistency in Issue Tickets
-
-```sh
-# baseline
-npm run dataset:english:baseline
-npm run benchmark
-
-# english
-npm run dataset:english
-npm run benchmark
-```
-
-> Presence of Code Snippets in Issue Tickets
-
-```sh
-# baseline
-npm run dataset:nosnip:baseline
-npm run benchmark
-
-# no snippets
-npm run dataset:nosnip
-npm run benchmark
-```
-
-#### generate dataset:
-
-Datasets can be downloaded either using `npm run dataset:balanced` or `npm run dataset:unbalanced`.
-The datasets were generated using github archive's which can be accessed through google [BigQuery](https://console.cloud.google.com/bigquery).
-
-Add the query below to your BigQuery console and adjust if needed (e.g., resample issues to create a balanced dataset, etc.).
-
-```sql
--- unbalanced dataset
-
-SELECT
-  CONCAT('__label__', label, ' ', title, ' ', REGEXP_REPLACE(body, '(\r|\n|\r\n)',' '))
-FROM (
-  SELECT
-    LOWER(JSON_EXTRACT_SCALAR(payload, '$.issue.labels[0].name')) AS label,
-    JSON_EXTRACT_SCALAR(payload, '$.issue.title') AS title,
-    JSON_EXTRACT_SCALAR(payload, '$.issue.body') AS body
-  FROM
-    `githubarchive.day.201802*`
-  WHERE
-    _TABLE_SUFFIX BETWEEN '01' AND '10'
-    AND type = 'IssuesEvent'
-    AND JSON_EXTRACT_SCALAR(payload, '$.action') = 'closed' )
-WHERE 
-  (label = 'bug' OR label = 'enhancement' OR label = 'question')
-  AND body != 'null';
-```
-
-#### run serverless app:
-
-You need a `.env` file in order to run the github app.
-The file should look like this:
-
-```
-GITHUB_CERT="<private key>"
-GITHUB_SECRET=123456
-GITHUB_APP_ID=123
-PORT=3000
-```
-
-Note: When running app in production, environment variables should be provided by host.