Skip to content

Latest commit

 

History

History
111 lines (73 loc) · 4.75 KB

README_pl.md

File metadata and controls

111 lines (73 loc) · 4.75 KB

Automatyczne tłumaczenie dokumentacji OpenAI

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

Ta dokumentacja została przetłumaczona automatycznie i może zawierać błędy. Nie wahaj się otworzyć Pull Request, aby zaproponować zmiany.

Instalacja

Narzędzie można zainstalować za pomocą NPM:

    npm install -g autotranslatedoc

Upewnij się, że skonfigurowano zmienne środowiskowe: GITHUB_PERSONAL_ACCESS_TOKEN i OPENAI_API_KEY. Alternatywnie, te tokeny można przekazać jako parametry. Aby uzyskać GITHUB_PERSONAL_ACCESS_TOKEN, zapoznaj się z dokumentacją GitHub.

"

Użycie

Strona Pomocy

Aby uzyskać dostęp do strony pomocy, użyj następującej komendy:

 autotranslatedoc -h

Tłumaczenie dokumentacji

Autotranslatedoc przyjmuje 3 argumenty i wiele opcji

    autotranslatedoc <command> <repo_org> <repo_name> (opcje)
  • command może być: translate (do tłumaczenia), update (do aktualizacji tłumaczenia), build (do budowania tłumaczenia)
  • repo_org to organizacja docelowego repozytorium na GitHub
  • repo_name to nazwa docelowego repozytorium na GitHub

Dostępne główne opcje to:

  • --language <lang_1>(, <lang_2>)* (lub -l) do wyboru języka, na który chcesz przetłumaczyć.
  • --docPath </url/path> (lub -d) do ograniczenia tłumaczenia do plików w określonej ścieżce.
  • --savePath <./localPath> (lub -s) do wyboru katalogu, w którym zostanie zapisany plik zapisu (domyślnie ./save).
  • --outputPath <./localPath> (lub -o) przy użyciu build, aby określić, gdzie będą zapisane przetłumaczone pliki dokumentacji (domyślnie ./build)

Aby przetłumaczyć dokumentację docelowego repozytorium na francuski i hiszpański, użyj:

    autotranslatedoc translate run-llama llama_index -l fr,es

To polecenie tworzy plik llama_index.json w katalogu run-lama określonego katalogu wyjściowego (domyślnie ./save).

    ls ./save
        run-llama
            llama_index.json 

Plik zapisu zawiera wszystkie tłumaczenia i może być używany do generowania dokumentacji w docelowym formacie (obecnie tylko .md).

Aby zbudować przetłumaczoną dokumentację, użyj:

    autotranslatedoc build run-llama llama_index -l fr,es

To polecenie generuje katalogi fr i es w buildPath (domyślnie ./build), zawierające przetłumaczone pliki dokumentacji.

Aby zaktualizować przetłumaczoną dokumentację na podstawie zmian w oryginalnych plikach, użyj:

    autotranslatedoc update run-llama llama_index -l fr,es

Aby przeglądać dokumentację za pomocą serwera (funkcja eksperymentalna), użyj:

    autotranslatedoc serve run-llama llama_index

Tłumaczenie dokumentacji Docusaurus

Aby przetłumaczyć dokumentację hostowaną w Docusaurus, użyj:

    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

Tłumaczenie tylko pliku README.md

Aby przetłumaczyć tylko plik README, użyj trybu readme:

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

Tłumaczenie na wszystkie obsługiwane języki

Aby przetłumaczyć na wszystkie obsługiwane języki, użyj opcji -l all:

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

Znane problemy

Obecnie tłumaczenie z użyciem -all jest obsługiwane tylko z języka angielskiego na wszystkie inne języki.