공식문서 활용하기 - 개발자

Jadon·2021년 12월 27일
0
post-thumbnail

Python, PyTorch, TensorFlow 등 대중화된 언어, 라이브러리, 프레임워크들은 개발자들이 본인들이 만든 언어나 라이브러리에 대해 자세하게 작성해놓은 설명서가 존재한다. 하지만 그런 오픈소스 툴을 사용하는 개발자들은 구글링에 의존하는 경향이 크다고 생각한다. 물론 아직 개발을 시작한 지 얼마 되지 않았다면 영어로 된 공식문서를 읽는 것보단 구글링으로 블로그 글 등을 읽는 것이 더 도움이 된다. 빠르게 원하는 정보를 찾을 수 있기 때문이다. 하지만 숙련도가 조금 올라가면 블로그에서 다루는 것으로는 부족한 경우가 많아진다. 예를 들면 어떤 함수의 파라미터로 어떤 값을 전달해야 하는지는 블로그 글만 읽으면 내가 원하는 정보를 찾을 수 없다. 이때 필요한 것이 공식문서를 보는 것이라고 생각한다.

공식문서는 대다수의 블로그 글과는 달리 최신 정보나 변경사항 또는 함수의 구조 등에 대해 매우 정확하게 확인할 수 있다. 요즘 PyTorch에 대해 공부하고 있는데 공식문서를 보는 것이 아주 중요하다는 것을 배우고 있다. 대부분의 언어가 그렇듯 함수명과 기능은 매우 유사하다. Tensorflow에서 모델 레이어를 쌓을 때 Sequential을 사용하는데 PyTorch에서도 동일하다. 하지만 공식문서는 영어로 되어있는 경우가 많고, 한글로 되어있다 하더라도 영어로 보는 문서가 훨씬 정확하다. TensorFlow를 예로 들자면, 이 글을 작성하는 2021년 8월 20일 기준으로 한글 공식문서와 영어 공식문서에 나와있는 Tutorial Code도 다르게 명시되어 있다.

처음 공식문서를 접하게 되면 방대한 양에 기가 눌리고 읽기가 두렵다. 특히 생소한 분야의 Docs라면 더더욱 말할 것이 없다. 그렇다면 공식문서를 보다 쉽고 재밌게 읽는 방법은 없을까? 지금부터 공식문서를 활용하는 방법을 알아보자.

요즘 공부하고있는 PyTorch 공식문서를 기준으로 알아볼 것이다.

PyTorch documentation

보통 먼저 버전을 확인해야 한다. 기본적으로 Stable 한 상태가 Default로 잡혀있지만 혹시 다를 수도 있으니 확인만 하면 된다. PyTorch는 공식문서 좌측 상단에 버전이 명시되어 있다.

1.9.0이 버전을 의미한다. 안정적인 버전이다. 버전을 눌러보면

이런 식으로 버전이 나오는데, stable 버전이라고 적혀있는 것을 볼 수 있다.

Python에서 torch를 사용할 것이기 때문에 Python API를 눌러서 확인해보았다.

이것만 보면 PyTorch를 처음 접하는 사람들은 어디서부터 들어가서 봐야 하고 어떤 것부터 시작해야 할지 막막하다. 나 역시 그랬다. 지인들이 공식문서 보는 습관을 들이면 좋다고 해서 보긴 하는데... 어떻게 봐야 하는지 감이 안 온다. 이럴 때 어떻게 해야 할까?

Tutorial의 중요성

대부분의 라이브러리나 프레임워크는 Tutorial 또는 Get Started를 제공한다. 쉽게 말해 처음 시작할 때 보는 것이다. 필요한 것을 설치할 수 있도록 자세하게 안내해준다. 알려주는 대로 따라 하기만 해도 어느 정도 감이 잡힌다. 꼼꼼히 읽어보면 기본적인 CS지식을 높이는 데 도움이 된다.

PyTorch Tutorials

튜토리얼을 어느정도 익숙해지면 그때부터는 필요할 때 Docs에 들어가서 필요한 함수에 대해 공부하거나 찾아서 사용하면 된다.

0개의 댓글