The Latex to LSC Compiler

2017-04-20T11:02:51Z

Achiya:

This page explains how to write Contextul LSCs (Con-LSC) in Latex, compile them into PlayGo LSC instances, and finally execute them.

In nutshell, these are the required steps:

#Download the PlayGo Environment.
#Add Latex Con-LSCs to LSC.tex.
#Execute the Latex2PlayGo compiler.
#Import the compiled file in PlayGo and execute it.

= The PlayGo Environment =

First you need to download ([https://weizmann.box.com/s/vze4kqq5gbf01cw92lx5dwijjju1pddb here]) a PlayGo version that includes a template project and the Latex2PlayGo compiler.

After extracting the zip file you will find the following directory structure (the structure includes only directories relevant to this tutorial). Directories are marked with (D) and files with (F):
<div><span style="font-family:courier new,courier,monospace;">(D) PlayGo_4.0_19042017</span></div><div style="margin-left: 40px;"><span style="font-family:courier new,courier,monospace;">|</span></div><div style="margin-left: 40px;"><span style="font-family:courier new,courier,monospace;">(D) playgo</span></div><div style="margin-left: 80px;"><span style="font-family:courier new,courier,monospace;">|</span></div><div style="margin-left: 80px;"><span style="font-family:courier new,courier,monospace;">(F) playgo.exe</span></div><div style="margin-left: 40px;"><span style="font-family:courier new,courier,monospace;">(D) workspace</span></div><div style="margin-left: 80px;"><span style="font-family:courier new,courier,monospace;">|</span></div><div style="margin-left: 80px;"><span style="font-family:courier new,courier,monospace;">(D) Latex2Lsc</span></div><div style="margin-left: 120px;"><span style="font-family:courier new,courier,monospace;">|</span></div><div style="margin-left: 120px;"><span style="font-family:courier new,courier,monospace;">(F) LSC.tex</span></div><div style="margin-left: 120px;"><span style="font-family:courier new,courier,monospace;">(F) GeneratedLSC.lsc</span></div><div style="margin-left: 120px;"><span style="font-family:courier new,courier,monospace;">(D) src</span></div><div style="margin-left: 160px;"><span style="font-family:courier new,courier,monospace;">|</span></div><div style="margin-left: 160px;"><span style="font-family:courier new,courier,monospace;">(F) Latex2PlayGoCompiler.java</span></div>
<br/>Executin playgo.exe will start PlayGo.

== General links: ==

[https://weizmann.box.com/s/irjrbvlipdol1vm64v0kf7uju00lqzn1 PlayGo userguide].

[http://wiki.weizmann.ac.il/playgo/index.php/Main_Page PlayGo homepage] - more information and tutorials.

= Latex Con-LSC =

== The Latex Con-LSC Language ==

Our group has developed a dedicated Latex package for easily creating diagrams with a simple textual notation, and presenting them graphically.

The package, called '''pgf-playgo-lsc''', is built upon the ''pgf<ref>T. Tantau and C. Feuersnger, “pgf—Create PostScript and PDF graphics in TEX,” Version 3.01a, 08 2015. [Online]. Available: https://www.ctan.org/pkg/pgf</ref>'' and ''pgf-uml''<ref>X. Yuan, “pgf-umlsd—Draw UML Sequence Diagrams,” Version 0.7, 02 2014. [Online]. Available: https://www.ctan.org/pkg/pgf-umlsd</ref> packages. The package imlements only part of the PlayGo LSC idioms. The complete list of the supported idioms in Latex Con-LSC is given in the package manual. The language semantics is defined in the [https://weizmann.box.com/s/irjrbvlipdol1vm64v0kf7uju00lqzn1 PlayGo userguide], except for the context idioms that are given in the paper.

The package repository and download link can be found at [http://github.com/eggsterino/pgf-playgo-lsc http://github.com/eggsterino/pgf-playgo-lsc].

Here we present an example for creating an LSC chart using pgf-playgo-lsc:

{| cellspacing="1" cellpadding="1" style="border-top: 1px solid; border-left: 0px; border-right: 0px; border-bottom: 1px solid;width: 600px"
|-
| style="vertical-align: top; width: 520px; border:none;" | <div>\begin{LSCnameddiagram}</div><div style="margin-left: 80px;">[title width=p{65px}]<br/></div><div style="margin-left: 80px;">{Turn lights off when motion has stopped}</div><div style="margin-left: 80px;"><br/></div><div style="margin-left: 40px;">\newlifeline {light} {light}</div><div style="margin-left: 40px;">\newlifeline {office} {office}</div><div style="margin-left: 40px;">\newlifeline {mSensor} {mSensor}</div><div style="margin-left: 40px;"><br/></div><div style="margin-left: 40px;"></div><div style="margin-left: 40px;">\coldmonitor {mSensor} {motionStopped()} {office}</div><div style="margin-left: 40px;">\hotexecute {office} {setOff()} {light}</div><div style="margin-left: 40px;"><br/></div><div>\end{LSCnameddiagram}</div>
| style="border: none; vertical-align: middle;" |
[[File:Latex-LSC.jpg|200px|Compiled pgf-playgo-lsc chart]]

Figure 1 - The compiled Latex representation of the code on the left.

|}
<div></div><div><br/></div><div>Please note that the LSC.tex file must have at least one LSC diagram. Also, no Latex command should appear outside the \begin \end scope.</div>

== The Latex2PlayGo Compiler ==

The Latex2PlayGo Compiler takes the Latex charts given in the LSC.tex file and compiles them to a PlayGo LSC file named GeneratedLSC.lsc. The compiler source code is the Latex2PlayGoCompiler.java file. Executing the compiler can be done in two ways:

#Compiling the file using ''javac'' and running it with ''java''.
#In PlayGo - Right click the source file and choose "Run as > Java Application".

= PlayGo =

== Preparing the PlayGo Project ==

Before we can execcute the generated LSCs, we need to prepare the project:

#Start PlayGo by executing playgo.exe.
#Refresh the project (Select the project root and press F5).
#On the right panel you have a window called "System Model".
#Locate the red X button.
#Press the button on the left to generate a system model from the scenarios.
#On the file selection window select GeneratedLSC.lsc.
#Click the button on the right of the red X button.
#Refresh the project (In the Package Explorer window: Right click on project name and then select Refresh)

The project is ready for a run.

== Running the Project ==

Required steps:

#Main menu: PlayGo -> Play-Out -> Play-Out....
#Delete any model under Behaviour Unit.
#Now press the add model and select GeneratedLSC.
#Press OK

Now you will notice that nothing happens. The reason is that due to a language requirement, each diagram starts with a monitor event. In the above example: the motionStopped() will be triggered only if the system (i.e. the sensor) will trigger the event. For the purpose of simulations and testings, PlayGo allows simulating system and user events from one lifeline to another.

For example, let us assume that we want to trigger the motionStopped event. In order to do so we neet to:

#Run the project.
#In the System Model window -> Objects:
##Right click mSensor and select "Call other object".
##Right click office and select "motionStopperd".

= References =

<references />

How to parse requirements using a trained statistical model

2014-11-09T07:09:08Z

Smadar:

You may have chosen to create a grammar file based on previously created LSC examples (as described in [[How to train a model for statistical play-in]]). In order to use this grammar for parsing your requirements document, you should upload the file and tune several meta-parameters. To do this follow these steps:

#Upload the newly created grammar file:
##Select the LSC project and choose Properties -> PlayGo --> Play-In.
##Select the 'Statistical NL' tab and choose the newly created statistical grammar file:<br>[[File:properties.playin.statisticalNL.png]]<br><br>
##Choose whether or not you would like the sentence context to be taken into account (default: with context).
##Choose the number of candidates for each sentence you would like the statistical model to consider (default: 16 candidates).<br>
Now, when you [http://wiki.weizmann.ac.il/harelgroup/index.php/How_to_Play-In#Uploading_a_requirements_document upload a requirements document], the newly created grammar will be used.

How to train a model for statistical play-in

2014-11-09T07:04:59Z

Smadar: Created page with "For NL play-in, one can improve the performance of the statistical parser by adding training examples. A training example is a file with an '''.st''' suffix that contains the ..."

For NL play-in, one can improve the performance of the statistical parser by adding training examples. A training example is a file with an '''.st''' suffix that contains the parse trees of previously-defined LSC examples.<br/>For existing LSC files created using NL play-in, you can generate the corresponding .st file by selecting the relevant .lsc file, right-clicking it, and choosing "export syntax tree".<br/><br/>To train the statistical model, follow these steps:

#Click the 'Train' toolbar button:<br/><br/>[[File:TrainAction.png]]<br><br>
#Click the 'Browse' button to select the full path and choose a name for the statistical grammar file you are about to create:<br/><br/>[[File:TrainDialogBrowse.png]]<br><br>
#Click the 'Add' button to select .st files for the model to be trained on. You can add (and remove) as many .st files as you wish:<br/><br/>[[File:TrainDialogAdd.png]]<br/><br/>Note that .st files for training, can be generated from LSCs created using NL play-in, by right-clicking a .lsc file and choosing 'Export Syntax Tree'. Examples for LSCs created using NL play-in can be found [[How to Play-In#Learn from Examples | here]].<br><br>
#When training a new model using user defined examples, we allow the user to interpolate the weights of the parameters learned from the user specified sample with previously learned weights from our set of 10000 randomly generated examples. Use the text boxes to define the weights of the parameters learned from the user examples and those previously learned by the system from random examples. By default, we assign 99% of the parameter weight for the parameters learned from user specified examples.<br><br>[[File:TrainDialogWeights.png]]<br><br>
#Click 'OK'.

WeizmannWiki - New pages [en]

The Latex to LSC Compiler

How to parse requirements using a trained statistical model

How to train a model for statistical play-in