Files
2023-12-07 20:47:44 +01:00

4.9 KiB

OpenAI Automatisoitu dokumentaation käännös

en| zh-Hans | es | ru | de | fr | ja | ko | pt | it | ar | tr | pl | nl | vi | th | fa | ro | sv | hu | cs | el | da | he | no | hi | zh_tw | in | sl | se | sk | uk | bg | hr | lt | lv | et | cat

Tämä dokumentaatio on käännetty automaattisesti ja se saattaa sisältää virheitä. Älä epäröi avata Pull Requestia ehdottaaksesi muutoksia.

Asennus

Työkalun voi asentaa NPM:n kautta:

    npm install -g autotranslatedoc

Varmista, että ympäristömuuttujat GITHUB_PERSONAL_ACCESS_TOKEN ja OPENAI_API_KEY on asetettu. Vaihtoehtoisesti nämä tunnisteet voidaan välittää parametreina. Katso GitHubin dokumentaatio GITHUB_PERSONAL_ACCESS_TOKEN-tunnuksen hankkimiseksi.

"

Käyttö

Ohjesivu

Pääset ohjesivulle seuraavalla komennolla:

 autotranslatedoc -h

Dokumentaation kääntäminen

Autotranslatedoc ottaa 3 argumenttia ja useita vaihtoehtoja

    autotranslatedoc <komento> <repo_org> <repo_name> (vaihtoehdot)
  • komento voi olla joko: translate (kääntämiseen), update (päivittämiseen käännöksessä), build (rakentamiseen käännöksessä)
  • repo_org on GitHubin kohdetietovaraston organisaatio
  • repo_name on GitHubin kohdetietovaraston nimi

Tärkeimmät käytettävissä olevat vaihtoehdot ovat:

  • --language <kieli_1>(, <kieli_2>)* (tai -l) valitaksesi käännöskielen.
  • --docPath </url/polku> (tai -d) rajoittaaksesi käännöksen tiettyihin polkuun sijoitettuihin tiedostoihin.
  • --savePath <./paikallinenPolku> (tai -s) valitaksesi hakemiston, johon tallennustiedosto tallennetaan (oletuksena ./save).
  • --outputPath <./paikallinenPolku> (tai -o) käytettäessä build, määrittääksesi, minne käännettyjen asiakirjatiedostojen tulisi sijoittua (oletuksena ./build)

Kääntääksesi kohdetietovaraston dokumentaation ranskaksi ja espanjaksi, käytä:

    autotranslatedoc translate run-llama llama_index -l fr,es

Tämä komento luo llama_index.json -tiedoston määritellyn tulostushakemiston run-lama -hakemistoon (oletuksena ./save).

    ls ./save
        run-llama
            llama_index.json 

Tallennustiedosto sisältää kaikki käännökset ja sitä voidaan käyttää dokumentaation generoimiseen halutussa muodossa (tällä hetkellä vain .md).

Käännetyt dokumentaatiotiedostot luodaan seuraavalla komennolla:

    autotranslatedoc build run-llama llama_index -l fr,es

Tämä komento luo fr ja es -hakemistot buildPath -hakemistoon (oletuksena ./build), jotka sisältävät käännetyn dokumentaation tiedostot.

Päivitä käännetyt dokumentaatiotiedostot alkuperäisten tiedostojen muutosten perusteella seuraavalla komennolla:

    autotranslatedoc update run-llama llama_index -l fr,es

Dokumentaation tarkastelu palvelimen kautta (kokeellinen ominaisuus) onnistuu seuraavalla komennolla:

    autotranslatedoc serve run-llama llama_index

Docusaurus-dokumentaation kääntäminen

Docusauruksessa isännöidyn dokumentaation kääntämiseen käytä:

    autotranslatedoc translate run-llama LlamaIndexTS --docPath /apps/docs/docs -l fr,es -m docusaurus
    autotranslatedoc build run-llama LlamaIndexTS --docPath /apps/docs/docs -l fr,es -m docusaurus

Vain README.md:n kääntäminen

Vain README-tiedoston kääntämiseksi käytä readme-tilaa:

    autotranslatedoc translate run-llama LlamaIndexTS -l fr,es -m readme
    autotranslatedoc build run-llama LlamaIndexTS  -l fr,es -m readme

Kääntäminen kaikille tuetuille kielille

Kääntääksesi kaikille tuetuille kielille, käytä -l all -valintaa:

    autotranslatedoc translate run-llama LlamaIndexTS -l all -m readme
    autotranslatedoc build run-llama LlamaIndexTS  -l all -m readme

Tiedossa olevat ongelmat

Tällä hetkellä käännös -all -vaihtoehdolla tuetaan vain englannista kaikkiin muihin kieliin.