grammatical-error-correction-system/README.md

# System automatycznej korekty tekstu - Transfix

## Instalacja serwera 

Serwery można uruchomić na maszynie z systemem operacyjnym Ubuntu, dodatkowo, serwer marian-server wymaga karty graficznej z minimum 12GB pamięci VRAM oraz zainstalowanego najnowszego pakietu CUDA.

Uruchomienie skryptu install.sh
```
chmod u+x install.sh
./install.sh
```

Utworzenie w katalogu ./backend pliku konfiguracyjnego .env

```
SECRET_KEY=secret_key
DEBUG=0
ALLOWED_HOSTS=localhost 127.0.0.1
//Adres serwera marian-server w formacie ws://ip:port/translate
TRANSLATION_WEBSOCKET=ws://150.254.78.132:443/translate
```

Uruchomienie serwera backend 
```
cd backend
python3 manage.py runserver 
```

Uruchomienie serwera marian-server na środowisku karty graficznej na porcie 443
```
sudo ./tools/marian/build/marian-server --port 443 -m model/model.npz -v model/vocab.ende.yml model/vocab.ende.yml
```

Dodanie stage w Jenkinsfile - należy go skopiować do repozytorium z pracą na której ma działać Jenkins i Transfix:

```
pipeline {

    agent {
        docker {
            image 'loxygen/autozoil'
        }
    }


    stages {

	stage ('build-pdf') {
            steps {
              withEnv(["HOME=${env.WORKSPACE}"]) {
                          sh """

make clean
make
"""
            }}

            post {
                always {
                    archiveArtifacts artifacts: 'msc-wojciech-jarmosz.pdf', fingerprint: true
                    archiveArtifacts artifacts: 'stats.txt', fingerprint: true
                }
            }

	}

	stage ('autozoil') {
            steps {
              withEnv(["HOME=${env.WORKSPACE}"]) {
              sh """
rm -f autozoil*.xml
make autozoil
"""
            }}

            post {
                always {
                    archiveArtifacts artifacts: 'autozoil*.xml', fingerprint: true
                    junit testResults: 'autozoil-external-check.xml',  skipPublishingChecks: true, allowEmptyResults: true
//                    junit testResults: 'autozoil.xml'
                }
            }
	}



    }
}
```

Skopiowanie plików z folderu helpers do repozytorium z pracą:
```
cp helpers/. ~/folder-with-document/helpers
```