본 포스팅은 공개 가능한 회사 프로젝트를 소개하는 방식과 방법에 대해 정리 해둔 포스팅입니다. 리서치 리포팅은 기술 블로그. API 서비스, 데이터 공개 및 소개 3 가지로 구성됩니다. 각 단계를 위해 사용되는 툴은 Github 블로그, fastAPI, huggingface Dataset입니다. 본 포스팅은 각 단계에 대한 환경 구성 방법과 컨텐츠 업로드 방법에 대해 설명하고 있습니다.
개요
저희 팀은 리서치 결과물을 효과적으로 공유하고 회사의 연구 역량을 홍보하기 위해 3가지 리포팅 시스템을 마련했습니다.
-
깃 블로그(GitHub 블로그)는 동료들과 세미나 자료, AI 모델 개발 과정, 학습 및 평가 데이터 등 리서치와 관련된 모든 내용을 자유롭게 공유하고 기록하는 공간입니다. 중요도나 소요 시간에 관계없이, 발견하거나 수행한 모든 지식을 빠짐없이 아카이빙하는 것을 원칙으로 합니다.
-
API 서비스(FastAPI)는 개발된 AI 모델을 고객사에 납품하거나 내부 서비스에 적용할 수 있도록 API 형태로 제공합니다. 모델 개발이 완료되면, 해당 모델을 FastAPI 기반의 코드로 구현하고 Docker 이미지로 패키징한 후, 마크다운 형식의 도큐먼트와 함께 서버 관리자에게 전달합니다. 이를 통해 서비스 활용성과 레퍼런스를 확보합니다.
- 데이터 관리(Hugging Face Dataset)는 학습에 사용된 데이터를 회사의 수익성 기준에 따라 일부 또는 전체를 공개하는 방식으로 운영됩니다. 필요에 따라 유료 혹은 무료로 데이터를 공개하며, 이를 통해 외부 개발자 및 연구자들이 더 많은 AI 모델을 개발할 수 있도록 기여합니다.
- ⚠️ 주의사항: 리서치 리포팅에 사용되는 서비스들은 각각 장단점이 있으며, 이 장단점은 시점에 따라 변할 수 있습니다. 더 좋은 방법이나 대안이 있더라도, 우선은 현재 정해진 방식을 최소 3번 이상 사용해본 후 팀장님 등에게 새로운 방법을 제안해 주시길 바랍니다.
내용
자세한 설명이 필요한 부분은 아래 표 링크를 통해 확인할 수 있습니다.
| 단계 | 환경구성 방법 | 컨텐츠 업로드 방식 |
|---|---|---|
| 기술블로그 | 깃허브 블로그 배포포 | 마크다운 작성 ruled by So Simple |
| API 서비스 | 파이썬 프레임워크(fastapi)활용 리버스 프록시 적용 중 |
fastapi 코드 기본 작성 규정 |
| 데이터관리 | 허깅페이스 데이터셋 | - |