PG-DSコース課題開発リポジトリ

PlayGround/データサイエンスコース で用いるための課題を改善、開発していくリポジトリです。

このリポジトリの課題の雛形はIntroduction to Deep Learning: Chainer Tutorialsです。

LICENSE

オリジナルのChainerTutorialのライセンスは ”BSD 3-Clause”です。
ライセンス原文
ライセンス日本語訳

環境

とりあえず、各自使用するライブラリをインストールする運用です

pre-commitのセットアップについて

このリポジトリではpre-commitを使うため、各自設定が必要です。

1. pre-commitのインストール
   pip install pre-commit
2. pre-commitの設定
   pre-commit install
   これにより.git/hooks/pre-commitにpre-commitがインストールされ、以後pre-commitが実行されるようになります。

ディレクトリ構造

• ja/ 元のChainerTutorialで使用されていたnotebookが保存されています。
  ここにあるファイルは編集しないでください。

• ja-edited/ ここにあるnotebookを編集して作業します。

• scripts/ja-edited/ ja-edited以下の.ipynb形式のファイルが.pyに変換されてここに保存されます。
  変換にはpre-commitとjupytextが使用されています。

開発ルール

実装は全て/ja-edited/*.ipynbに対して行ってください。

ポイント

• 新規課題の追加・課題の変更を行う際は必ずissueを立てる
• 課題の追加は feature/追加課題を表すタイトルブランチで行う
• 課題の変更は fix/変更を表すタイトルブランチで行う
• 変更を追加し終わったらpushしてPRを送信し、レビューをもらう
  • レビュワー：(wip)

pre-commit

このプロジェクトではpre-commitを使用してipynbファイルとpyファイルの内容を同期させています。
詳細は.pre-commit-config.yamlを参照してください。

jupytext

pre-commitによってjupytextコマンドが実行され、 ja-edited/hoge.ipynbの内容がscripts/ja-edited/hoge.pyに反映されます。
この際上記のファイルの両方がステージングされている必要があります。