CSC/ECE 517 Fall 2018/E1878 Integrate Suggestion Detection Algorithm - Revision history

Adhaval: /* Pre-requisites */

2018-12-12T17:36:13Z

Pre-requisites

← Older revision		Revision as of 17:36, 12 December 2018
Line 61:		Line 61:
	# Cores plug-in (link in references)		# Cores plug-in (link in references)

			Before the JSON response is displayed, certain fields are first filtered out or formatted. For instance, the field "text" is filtered out as it is redundant to display it again. The field "sentiment_tone" is formatted with the help of another font color JSON depending on its value.
	Following is the code snippet of our implementation :		Following is the code snippet of our implementation :

Line 78:		Line 79:
	data: json_review,		data: json_review,
	dataType: "json",		dataType: "json",
			//Response JSON fields are filtered and then displayed

	success: function (response) {		success: function (response) {
	console.log("success");		console.log("success");
Line 86:		Line 89:
	"Mixed": ":</b> <font style=\"color:saddlebrown;\">"};		"Mixed": ":</b> <font style=\"color:saddlebrown;\">"};
	APIresultbox += "<table border='1'>"		APIresultbox += "<table border='1'>"
			//Add the response to the API result box
	for (x in response) {		for (x in response) {
			if(x == "text"){
			continue;
			}
	if (x == "sentiment_tone")		if (x == "sentiment_tone")
	APIresultbox += "<tr><td><b> " + x + colors[response[x]] + response[x] + "</font></td></tr>";		APIresultbox += "<tr><td><b> " + x + colors[response[x]] + response[x] + "</font></td></tr>";
Line 92:		Line 99:
	APIresultbox += "<tr><td><b> " + x + ":</b> " +response[x] + "</td></tr>";		APIresultbox += "<tr><td><b> " + x + ":</b> " +response[x] + "</td></tr>";
	}		}
	~~//API result box~~
	APIresultbox += "</table>"		APIresultbox += "</table>"
	console.log(APIresultbox);		console.log(APIresultbox);
Line 102:		Line 108:
	},		},
	error: function (xhr, status) {		error: function (xhr, status) {
	console.log(status)		console.log(status)
	$('#save_progress').html('Unable to reach suggestion detection service at the moment')		$('#save_progress').html('Unable to reach suggestion detection service at the moment')
	}		}

Pkannia: /* UML Diagrams */

2018-12-07T22:31:58Z

UML Diagrams

← Older revision		Revision as of 22:31, 7 December 2018
Line 51:		Line 51:

	The overall flow of the logic is explained as follows:		The overall flow of the logic is explained as follows:

	[[File:Latest_Prash_screenshot.png]]		[[File:Latest_Prash_screenshot.png]]

Pkannia: /* UML Diagrams */

2018-12-07T22:31:23Z

UML Diagrams

← Older revision		Revision as of 22:31, 7 December 2018
Line 51:		Line 51:

	The overall flow of the logic is explained as follows:		The overall flow of the logic is explained as follows:
			[[File:Latest_Prash_screenshot.png]]
	[[File:~~Flowchart_Prashanthi~~.png]]

	==Implementation==		==Implementation==

Adhaval: /* Test plan */

2018-12-07T21:57:35Z

Test plan

← Older revision		Revision as of 21:57, 7 December 2018
Line 126:		Line 126:
	No suggestions are displayed		No suggestions are displayed


	Scenario: Display Suggestion Metrics on Review Segment with Text		Scenario: Display Suggestion Metrics on Review Segment with Text
	Given the Student has entered any form of text in the review segment		Given the Student has entered any form of text in the review segment

Adhaval: /* Expected State */

2018-12-07T21:55:40Z

Expected State

← Older revision		Revision as of 21:55, 7 December 2018
Line 46:		Line 46:

	[[File:Before.jpg]]		[[File:Before.jpg]]

	~~====Expected State====~~
	We plan to implement buttons next to each text box so that the student can check their review for volume, sentiment, suggestion, praise and criticism metrics. The rationale for including buttons right next to each text box, is so that the student gets to test only the written matter that they wish to check, and not the entirety of their review.


	~~[[File:After.jpg]]~~

	====UML Diagrams====		====UML Diagrams====

Adhaval: /* Suggestion detection algorithm */

2018-12-07T21:53:21Z

Suggestion detection algorithm

← Older revision		Revision as of 21:53, 7 December 2018
Line 13:		Line 13:

	====Suggestion detection algorithm====		====Suggestion detection algorithm====
	Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. In the same time, we hope students could also gain knowledge from the reviews received thus improve their own performance. ~~In order to make this happen, we would like to have everyone give quality reviews instead of generic ones.~~		Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. In the same time, we hope students could also gain knowledge from the reviews received thus improve their own performance.
	'''Currently, we have a few classifiers that could catch useful components of review comments, such as if it contains suggestions, etc. These classifiers are already ported into web services that we’d like to be integrated into Expertiza.''' As stated in the Problem statement, we ~~will be getting~~ the response from the REST endpoints as given and integrate it with Expertiza. The suggestion detection algorithm from which we are getting the metrics is added in the "References" section in case more details are needed on it. '''According to the problem statement, we will be considering the "Suggestion Detection Algorithm" to be a black box, which take a json with text as input and returns a json with few metrics as given below.'''
			'''Currently, we have a few classifiers that could catch useful components of review comments, such as if it contains suggestions, etc. These classifiers are already ported into web services that we’d like to be integrated into Expertiza.''' As stated in the Problem statement, we get the response from the REST endpoints as given and integrate it with Expertiza. The suggestion detection algorithm from which we are getting the metrics is added in the "References" section in case more details are needed on it. '''According to the problem statement, we will be considering the "Suggestion Detection Algorithm" to be a black box, which take a json with text as input and returns a json with few metrics as given below.'''

	''Input JSON to "Suggestion Detection Algorithm"''		''Input JSON to "Suggestion Detection Algorithm"''

Adhaval: /* Test plan */

2018-12-07T21:51:01Z

Test plan

← Older revision		Revision as of 21:51, 7 December 2018
Line 130:		Line 130:
	When the Student clicks outside the textbox		When the Student clicks outside the textbox
	No suggestions are displayed		No suggestions are displayed


	Scenario: Display Suggestion Metrics on Review Segment with Text		Scenario: Display Suggestion Metrics on Review Segment with Text
	Given the Student has entered any form of text in the review segment		Given the Student has entered any form of text in the review segment
Line 141:		Line 142:
	Then a table will show the user the results of the suggestion metrics analysis		Then a table will show the user the results of the suggestion metrics analysis

	Scenario: Display Suggestion Metrics on Review Segment with Text		Scenario: Display Suggestion Metrics on Review Segment with Text
	Given the Student has entered negative text and suggestions in the review segment		Given the Student has entered negative text and suggestions in the review segment
	When the Student clicks outside the text box for the segment		When the Student clicks outside the text box for the segment

Adhaval: /* Test plan */

2018-12-07T21:48:37Z

Test plan

← Older revision		Revision as of 21:48, 7 December 2018
Line 125:		Line 125:
	I want to view a popup displaying the suggestion metrics for the segment of the review I am writing		I want to view a popup displaying the suggestion metrics for the segment of the review I am writing
	So that I can use it to improve the relevance of the review segment provided		So that I can use it to improve the relevance of the review segment provided

	Scenario: Display Suggestion Metrics on Empty Review Segment		Scenario: Display Suggestion Metrics on Empty Review Segment
	Given the Student has not entered any text in the review segment		Given the Student has not entered any text in the review segment
	When the Student clicks the ~~Analyze button~~ for the segment		When the Student clicks outside the textbox
	Then a ~~popup~~ will show ~~that~~ the user ~~has not entered any text for~~ suggestion metrics analysis.		No suggestions are displayed

			Scenario: Display Suggestion Metrics on Review Segment with Text
			Given the Student has entered any form of text in the review segment
			When the Student clicks outside the text box for the segment
			Then a table will show the user the results of the suggestion metrics analysis

	Scenario: Display Suggestion Metrics on Review Segment with Text		Scenario: Display Suggestion Metrics on Review Segment with Text
	Given the Student has entered ~~any form~~ of text in the review segment		Given the Student has entered positive text and suggestions in the review segment
	When the Student clicks the ~~Analyze button~~ for the segment		When the Student clicks outside the text box for the segment
	Then a ~~popup~~ will show the user the results of the suggestion metrics analysis		Then a table will show the user the results of the suggestion metrics analysis

			Scenario: Display Suggestion Metrics on Review Segment with Text
			Given the Student has entered negative text and suggestions in the review segment
			When the Student clicks outside the text box for the segment
			Then a table will show the user the results of the suggestion metrics analysis

	==References==		==References==

Adhaval at 22:46, 4 December 2018

2018-12-04T22:46:33Z

← Older revision		Revision as of 22:46, 4 December 2018
Line 140:		Line 140:
	#[http://github.com/expertiza/expertiza Expertiza on GitHub]		#[http://github.com/expertiza/expertiza Expertiza on GitHub]
	#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]		#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
			#[http://chrome.google.com/webstore/detail/allow-control-allow-origi/nlfbmbojpeacfghkpbjhddihlkkiljbi?hl=en Plug-In: Cores]

Adhaval: /* Implementation */

2018-12-04T22:45:36Z

Implementation

← Older revision		Revision as of 22:45, 4 December 2018
Line 60:		Line 60:

	==Implementation==		==Implementation==

			===Pre-requisites===
			Following are the necessary steps needed to be set up in order to have the feature running :
			# Browser: Google Chrome
			# Cores plug-in (link in references)

	Following is the code snippet of our implementation :		Following is the code snippet of our implementation :