Apertium-regtest - Revision history

Jwashin1: /* Manually adding tests */

2023-02-27T18:27:28Z

‎Manually adding tests

Jwashin1: /* Using the web interface */

2023-02-27T18:22:51Z

‎Using the web interface

Jwashin1: /* Commands */

2023-02-21T14:51:15Z

‎Commands

Jwashin1: /* Using the web interface */

2023-02-21T14:50:18Z

‎Using the web interface

Jwashin1: /* Using the web interface */

2023-02-21T14:49:52Z

‎Using the web interface

Jwashin1: /* Commands */

2023-02-21T14:48:04Z

‎Commands

Jwashin1: /* Commands */

2023-02-21T14:43:15Z

‎Commands

Jwashin1: /* Commands */

2023-02-21T14:42:35Z

‎Commands

Jwashin1 at 14:42, 21 February 2023

2023-02-21T14:42:16Z

Jwashin1: Created page with "The tool apertium-regtest is a "regression test" tool that helps to test large numbers of inputs simultaneously and to keep track of what has changed a..."

2023-02-21T05:23:37Z

Created page with "The tool apertium-regtest is a "regression test" tool that helps to test large numbers of inputs simultaneously and to keep track of what has changed a..."

New page

The tool [[:w:apertium-regtest|apertium-regtest]] is a "regression test" tool that helps to test large numbers of inputs simultaneously and to keep track of what has changed and what is still wrong.

== General premise and structure ==

Apertium-regtest runs as a web client, a command-line interface, or simply checks tests on the command line.

When run from a transducer or translation directory, it checks the <code>test/</code> directory for tests.

Each test consists of a list of inputs and a list of "gold" (i.e., correct) forms provided by the user, as well as a list of output forms generated by the software upon request and a list of expected forms, generated as the user interacts with the software

== Commands ==

* To run apertium-regtest to access in a web browser:
*: <code>% apertium-regtest web</code>
* To set up an ssh tunnel to a lab machine, if remote
*: <code>$ ssh -NL 3000:localhost:3000 machinename.cs.swarthmore.edu</code> (with the machine's name for <code>machinename</code>)
** Then you should be able to access http://localhost:3000 from the computer this command is run on.
* To check the number of morph tests matching gold:
*: <c0de>$ apertium-regtest test -c .-morph</code>

[[Category:tools]]

@@ Line 47: / Line 47: @@
 # Add gold
 #* If the output of the test is correct, just click "Add as gold"; if not, click "Add manual gold" and add the correct output manually
 [[Category:tools]]

← Older revision		Revision as of 18:22, 27 February 2023
Line 36:		Line 36:
	* Apertium-regtest is fairly new and the lore for how to use it hasn't been well established. So you get to help with that!		* Apertium-regtest is fairly new and the lore for how to use it hasn't been well established. So you get to help with that!

		+	== Manually adding tests ==
		+	# Identify the right file:
		+	#* To add an analysis test, find the correct <code>*-morph-input.txt</code> file.
		+	#* To add a generation test, find the correct <code>*-gen-input.txt</code> file.
		+	#* If you add a file instead of using an existing one, you'll need to add it to the <code>test/tests.json</code> file.
		+	# Simply add a line to this file with the input (for analysis it should be a form; for generation it should be an analysis)
		+	# Load the regtest web interface (<code>apertium-regtest web</code>); there should be a notification in red that tests were added. Click the button to accept all.
		+	# Now rerun tests ("All Corpora", or just the one that you modified)
		+	# Filter by "no gold"
		+	# Add gold
		+	#* If the output of the test is correct, just click "Add as gold"; if not, click "Add manual gold" and add the correct output manually

	[[Category:tools]]		[[Category:tools]]

@@ Line 13: / Line 13: @@
 * To run apertium-regtest to access in a web browser:
 *: <code>$ apertium-regtest web</code>
-* To set up an ssh tunnel to a lab machine, if remote
+* To set up an ssh tunnel to a lab machine, to allow you to access the web interface remotely:
 *: <code>$ ssh -NL 3000:localhost:3000 machinename.cs.swarthmore.edu</code> (with the name of the machine you're running apertium-regtest on in place of <code>machinename</code>)
 ** Then you should be able to access http://localhost:3000 from the computer this command is run on.

@@ Line 21: / Line 21: @@
 == Using the web interface ==
 # First you'll want to click the button to '''run all tests'''.
 # Then you want to accept all tests as expected (even if incorrect / not matching gold).  You'll probably have to click on the button for each test.
 # Then you can filter for e.g. tests not matching gold.
-When you update something in your transducer or translator and recompile, you'll want to:
+When you '''update something''' in your transducer or translator and recompile, you'll want to:
 # Rerun all tests.
 # The software will show you what's changed.  You'll want to accept the updated forms as expected (again, even if incorrect / not matching gold).
-Note:
+Notes:
 * For working on [[morphological analyser|the analyser]], you'll mostly just want "-morph" tests.  For working on [[morphological generator|the generator]], you'll mostly want just "-gen" tests.  Feel free to filter on these
 * Apertium-regtest can also be used to work on translation.

@@ Line 30: / Line 30: @@
 Note:
 * There are a few [https://github.com/apertium/apertium-regtest/issues known issues with the web interface].
 * Apertium-regtest is fairly new and the lore for how to use it hasn't been well established.  So you get to help with that!

@@ Line 18: / Line 18: @@
 * To check the number of morph tests matching gold:
 *: <code>$ apertium-regtest test -c .-morph</code>
 [[Category:tools]]

← Older revision		Revision as of 14:42, 21 February 2023
Line 1:		Line 1:
−	The tool [[:w:apertium-regtest\|apertium-regtest]] is a "regression test" tool that helps to test large numbers of inputs simultaneously and to keep track of what has changed and what is still wrong.	+	The tool [[:apertium:apertium-regtest\|apertium-regtest]] is a "regression test" tool that helps to test large numbers of inputs simultaneously and to keep track of what has changed and what is still wrong.

	== General premise and structure ==		== General premise and structure ==