Help protect the Great Barrier Reef with TensorFlow on Kaggle Join Challenge

TensorFlow 문서에 기여

TensorFlow는 문서 기여를 환영합니다. 문서를 개선하면 TensorFlow 라이브러리 자체도 개선됩니다. tensorflow.org의 문서는 다음 범주로 분류됩니다.

일부 TensorFlow 프로젝트는 일반적으로 별도의 저장소에 코드 근처에 문서의 원본 파일을 보관 docs/ 디렉토리. 프로젝트의 참조 CONTRIBUTING.md 파일을하거나 기여할 수있는 프로젝트 관리자에게 문의하십시오.

TensorFlow 문서 커뮤니티에 참여하려면:

API 참조

자세한 내용은 사용 TensorFlow API 문서에 기여 가이드 . 이 쇼 당신은 방법을 찾기 위해 소스 파일 편집 심볼의 문서화 문자열을 . tensorflow.org의 많은 API 참조 페이지에는 기호가 정의된 소스 파일에 대한 링크가 포함되어 있습니다. 문서화 문자열을 지원 마크 다운을 하고 (약) 어떤 사용하여 미리 볼 수 있습니다 마크 다운 미리보기 프로그램을 .

버전 및 분기

이 사이트의 API 참조 최신 안정 버전에 기본적으로 이진은-이 설치 패키지와 일치 pip install tensorflow .

기본 TensorFlow 패키지는 안정적인 지점에서 구축 rX.x 주에 tensorflow / tensorflow 의 repo. 참조 문서의 소스 코드의 코드 주석 및 문서화 문자열에서 생성 파이썬 , C ++자바 .

TensorFlow 문서의 이전 버전으로 사용할 수 있습니다 rX.x 가지 TensorFlow 문서 저장소입니다. 이러한 분기는 새 버전이 릴리스될 때 추가됩니다.

API 문서 작성

파이썬 참조

tensorflow_docs 패키지에 대한 발전기 포함 파이썬 API 참조 문서를 . 설치하기 위해서:

pip install git+https://github.com/tensorflow/docs

사용의 TensorFlow 2 참조 문서를 생성하려면 tensorflow/tools/docs/generate2.py 스크립트를 :

git clone https://github.com/tensorflow/tensorflow tensorflow
cd tensorflow/tensorflow/tools/docs
pip install tensorflow
python generate2.py --output_dir=/tmp/out

내러티브 문서

TensorFlow의 가이드자습서 로 기록 된 마크 다운의 파일과 상호 작용 Jupyter의 노트북. 노트북을 사용하여 브라우저에서 실행할 수 있습니다 구글 Colaboratory을 . 의 이야기 문서 tensorflow.org는 으로부터 내장되어 tensorflow / 문서의 master 지점입니다. 이전 버전은에 GitHub의에서 사용할 수있는 rX.x 릴리스 분기합니다.

간단한 변경

마크 다운 파일을 간단 설명서 업데이트를 확인하는 가장 쉬운 방법은 GitHub의의 사용하는 웹 기반 파일 편집기를 . 찾아보기 tensorflow / 문서 저장소 약은에 해당하는 마크 다운을 찾을 수 tensorflow.org의 URL 구조. 파일 보기의 오른쪽 상단에서 연필 아이콘 파일 편집기를 엽니다. 파일을 편집한 다음 새 pull 요청을 제출합니다.

로컬 Git 리포지토리 설정

다중 파일 편집 또는 더 복잡한 업데이트의 경우 로컬 Git 워크플로를 사용하여 풀 요청을 생성하는 것이 좋습니다.

다음 Git 단계는 로컬 프로젝트를 처음 설정할 때만 필요합니다.

tensorflow/docs 리포지토리 포크

tensorflow / 문서 GitHub의 페이지에서 포크 버튼을 클릭합니다 GitHub 계정에서 고유한 repo 사본을 생성합니다. 분기되면 업스트림 TensorFlow 리포지토리를 사용하여 리포지토리 복사본을 최신 상태로 유지할 책임이 있습니다.

저장소 복제

원격 사본 다운로드 username / 문서는 로컬 컴퓨터에 REPO. 다음은 변경할 작업 디렉토리입니다.

git clone git@github.com:username/docs
cd ./docs

최신 상태를 유지하기 위해 업스트림 리포지토리 추가(선택 사항)

와 동기화하여 로컬 저장소 유지하기 위해 tensorflow/docs , 최신 변경 사항을 다운로드 업스트림 리모컨을 추가합니다.

리모컨 추가:

git remote add upstream git@github.com:tensorflow/docs.git

# View remote repos
git remote -v
origin    git@github.com:username/docs.git (fetch)
origin    git@github.com:username/docs.git (push)
upstream  git@github.com:tensorflow/docs.git (fetch)
upstream  git@github.com:tensorflow/docs.git (push)

업데이트하려면:

git checkout master
git pull upstream master

git push  # Push changes to your GitHub account (defaults to origin)

GitHub 워크플로

1. 새 브랜치 생성

당신이에서 당신의 repo 업데이트 한 후 tensorflow/docs 로컬 마스터 지점에서 새로운 지점을 만듭니다

git checkout -b feature-name

git branch  # List local branches
  master

* feature-name

2. 변경

편집 좋아하는 편집기에서 파일과 따르십시오 TensorFlow 문서 스타일 가이드를 .

파일 변경 사항을 커밋합니다.

# View changes
git status  # See which files have changed
git diff    # See changes within files

git add path/to/file.md
git commit -m "Your meaningful commit message for the change."

필요에 따라 커밋을 더 추가합니다.

3. 풀 리퀘스트 생성

원격 GitHub의의의 repo (github.com/에 현지 지사를 업로드 username / 문서) :

git push

푸시가 완료된 후 업스트림 리포지토리에 풀 요청을 자동으로 제출하는 URL이 메시지에 표시될 수 있습니다. 는 이동하지 않으면 tensorflow / 문서는 REPO 또는 자신의 repo 및 GitHub의는 풀 요청을 생성하라는 메시지를 표시합니다.

4. 검토

유지 관리자 및 기타 기여자가 끌어오기 요청을 검토합니다. 토론에 참여하고 요청한 변경을 수행하십시오. pull 요청이 승인되면 업스트림 TensorFlow 문서 저장소에 병합됩니다.

업데이트에 대한 별도의 출판 단계가 tensorflow.org GitHub의의의 repo에서가. 일반적으로 변경 사항은 일괄 처리되고 사이트는 정기적으로 업데이트됩니다.

대화형 노트북

이 편집 GitHub의의와 노트북 JSON 파일에 가능하지만 웹 기반 파일 편집기 , 그것은 잘못된 JSON 이후 파일을 손상 할 수 있습니다하지 않는 것이 좋습니다. 풀 리퀘스트를 제출하기 전에 노트북을 테스트하십시오.

구글 Colaboratory은 편집 및 실행 노트북 설명서에 쉽게 그것을 만드는 호스팅 노트북 환경입니다. : GitHub의에서 노트북 예를 들어, 여기 GitHub의에있는 노트북의 Colab URL 경로를 전달하여 구글 Colab에로드 https://github.com/tensorflow/docs/blob/master/site/en/tutorials/keras /분류.ipynb
이 URL에서 구글 Colab에로드 할 수 있습니다 https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/keras/classification.ipynb

열기 Colab의 수행이 URL 대체 GitHub의에 노트북을 검색하는 것이 크롬 확장. 당신의 repo 포크에 노트북을 열 때 상단 버튼은 항상 TensorFlow 문서에 링크를 때문에, 유용 master 지점입니다.

노트북 포맷

노트북 서식 도구를 사용하면 Jupyter 노트북 소스 diff를 일관되고 쉽게 검토할 수 있습니다. 노트북 저작 환경은 파일 출력, 들여쓰기, 메타데이터 및 기타 지정되지 않은 필드와 관련하여 다르기 때문에; nbfmt TensorFlow 워드 프로세서 Colab 워크 플로우의 설정에 기본값을 완고 사용합니다. 노트북을 포맷하려면, 설치 TensorFlow 문서 노트북 도구 및 실행 nbfmt 도구를 :

# Install the tensorflow-docs package:
$ python3 -m pip install -U [--user] git+https://github.com/tensorflow/docs

$ python3 -m tensorflow_docs.tools.nbfmt [options] notebook.ipynb [...]

TensorFlow 문서 프로젝트의 출력 세포없이 노트북 실행 및 테스트; 있는 그대로 저장 출력 세포 노트북은 게시됩니다. nbfmt 노트북의 상태를 존중하고 사용 --remove_outputs 명시 적으로 출력 세포를 제거하는 옵션을 선택합니다.

새로운 노트북을 만들려면 복사 및 편집 TensorFlow 문서 노트북 템플릿 .

Colab에서 수정

Google Colab 환경 내에서 셀을 두 번 클릭하여 텍스트 및 코드 블록을 편집합니다. 텍스트 세포는 마크 다운을 사용하고 따라야 TensorFlow의 문서 스타일 가이드 .

파일> 다운로드 .pynb와 Colab에서 다운로드 노트북 파일. 당신이 파일을 커밋 지역 힘내의 repo 및 끌어 오기 요청을 보냅니다.

새로운 노트북을 만들려면 복사 및 편집 TensorFlow 노트북 템플릿 .

Colab-GitHub 워크플로

노트북 파일을 다운로드하고 로컬 Git 워크플로를 사용하는 대신 Google Colab에서 직접 분기된 GitHub 리포지토리를 편집하고 업데이트할 수 있습니다.

  1. 당신의 갈래에서 username / 문서는 REPO,하는 GitHub의 웹 UI를 사용하는 새로운 지점을 만듭니다 .
  2. 편집할 노트북 파일로 이동합니다.
  3. 구글 Colab에서 노트북을 열기 : URL 스왑 또는 Colab 크롬 확장 프로그램의 열기를 사용합니다.
  4. Colab에서 노트북을 수정합니다.
  5. 파일과 Colab에서의 repo에 변경 사항을 커밋> 저장 GitHub의에 복사본 .... 저장 대화 상자는 적절한 리포지토리 및 분기에 연결되어야 합니다. 의미 있는 커밋 메시지를 추가합니다.
  6. 당신의 repo 또는하려면 찾아보기 저장 한 후에 tensorflow를 / 문서는 REPO, GitHub의는 풀 요청을 생성하라는 메시지를 표시합니다.
  7. pull 요청은 관리자가 검토합니다.

번역

TensorFlow 팀은 커뮤니티 및 공급업체와 협력하여 tensorflow.org에 대한 번역을 제공합니다. 노트북 및 기타 기술적 인 내용의 번역은에 있습니다 tensorflow / 문서-L10N GitHub의의의 repo. 관통 풀 요청을 제출하시기 바랍니다 TensorFlow GitLocalize 프로젝트 .

영어 문서는 소스 진리의 및 번역이 가능한 한 가깝게 이러한 가이드를 따라야이다. 즉, 번역은 그들이 봉사하는 지역 사회를 위해 작성되었습니다. 영어 용어, 표현, 문체 또는 어조가 다른 언어로 번역되지 않는 경우 독자에게 적합한 번역을 사용하십시오.

언어 지원 메트릭과 수요, 지역 사회 지원을 포함-만에 현장 국한되지 요인에 의해 결정되는 영어 능력 , 고객 선호도 및 기타 지표. 지원되는 언어마다 비용이 발생하므로 유지 관리되지 않는 언어는 제거됩니다. 새로운 언어에 대한 지원은에 발표 될 예정 TensorFlow 블로그 또는 트위터 .

선호하는 언어가 지원되지 않는 경우 오픈 소스 기여자를 위한 커뮤니티 포크를 유지할 수 있습니다. 이것들은 tensorflow.org에 게시되지 않습니다.