Commit 2c72fa63 authored by Seyed Reza  Sajjadinasab's avatar Seyed Reza Sajjadinasab
Browse files

Merge branch 'Reza' into 'master'

updateReadME

See merge request ec504/ec504_projects/group6!73
parents ff29a3fc 828e16ce
Loading
Loading
Loading
Loading
+4 −3
Original line number Diff line number Diff line
@@ -64,7 +64,7 @@ In order to have a checker/corrector that is working properly it needs to proces
    - For the implementation we use a GUI interface and implement it in the corrector so that we can interact with GUI and get and pass the information.
- Develop and Android client for your checker. [15%]
    - For the most part, the Android client of the checker is interfacing with the Checker CLI tool to produce its output in a pop-up window on the app. To do this, the Checker tool was modified so that it did not write the checked result to a JSON file (and instead kept it as a JSON string) as well as not require CLI arguments for the script to function. In addition, helper class functions were used to display the output to the user in the app.
- Extend your system to a language in which none of the team members have fluency. [15% per language, up to 3] - 1x
- Extend your system to a language in which none of the team members have fluency. [15% per language, up to 3] - 2x
    - We added the ability to crawl Dutch websites by adding a Dutch webpage seed to our crawler. Usage: use `--dutchSeed` argument for the crawler. Additional Dutch websites to crawl can be specified by adding their URLs to a file and using the `--file [filename.txt]` argument for the crawler. Also, for the checker and corrector things are similar to english but you need to usee `--dutch` option. The same goes for `--turkish` as the second language that we have not proficiency in.
- Provide a reasonable translation from English to another language based on common language structures. [30%] 
    - We added the ability to translation from Dutch to English and from English to Dutch. We accomplished this by crawling a Dutch to English online dictionary and translating the words literally. Usage: use `--dutchDict` argument with crawler to re-crawl the dictionary. For translation we used crawled dictionary and translate the data on both side.`--translateToEnglish` and `--translateToDutch` in corrector will do this.
@@ -99,7 +99,7 @@ Reza Sajjadinasab,
Alexander Ross Melnick,
Michael Harkess

### Known Issues/Bugs/Limitation
### Known Issues/Bugs/Limitations

#### Checker/Corrector
- The biggest limitation of our tool is the amount of data that is stored in our databases and the amount of self-training and user feedback that has been given to our tool.
@@ -111,7 +111,8 @@ Michael Harkess
- The way Apostrophe s is handled is to expand the clause, e.g. "it's -> it is" and "John's car -> car of John"
- If for any reason the database left in-use by a process and you kept getting the error that an specific `databse is locked`, run `fuser databaseName.db` and kill all the process that are active, using `kill -9 <process_number>`
- We used some LLMs produced text, as well as crawled data to update our database with different language structure.
- The tool transform everything to lowercase, so the shown sentences are a little different than what the actual input was.
- The tool transform everything to lowercase, so the shown sentences are a little different than what the actual input is.


#### Android App
- If a dialog box pops up and the device/screen is rotated, then the app will unexpectedly crash