Skip to content

Home

Jump to bottom
Ryuji Watanabe edited this page Jun 6, 2020 · 4 revisions

こちらは研究室内のメンバーに向けて情報をまとめているページです（Githubの一般的な活用方法も含む）。

Directories

.
├── libs                    # libraries ライブラリ
│   ├── datasets            # module to return datasets データセットを返すモジュール
│   ├── models              # class of models such as SOM, TSOM... SOMやTSOMなどの学習アルゴリズムのクラス
│   ├── tools               # utility tools あらゆるライブラリで共通して用いるような汎用的なもの
│   └── visualization       # module to visualize such as U-matrix, Component Plane... 描画用のライブラリ
├── playground              # prototype code with playing 試しに作ってみた系のコード
├── tests                   # code to test libraries 開発した学習アルゴリズムが正しく動作するかどうかチェックするための実行ファイル置き場．
│                           # place test code when you review pull request プルリクエストのレビューの際の検証コードはここに置く
└── tutorials               # tutorial of libraries アルゴリズムのチュートリアルを実行するファイル置き場

How to use?

How to introduce into your repository リポジトリへの導入方法

以下のようなやり方があります

  • poetry
  • 自分でsetup.pyなどの設定ファイルを書くなどしてパスを通す
  • submodule（非推奨）

submoduleで導入した後の設定（Pycharm）

Pycharm上で利用する場合は，somfのディレクトリをSource rootに設定すると，somfのチュートリアルコードと同様の書き方でライブラリを利用することができます．ただし，大元のリポジトリの中にsomf内のディレクトリと同じ名前のディレクトリがあるするとコンフリクトを起こしたりするので注意してください．

How to request bug fix and new feature? バグ修正や新機能追加の依頼の出し方

Please create Issues, use template.
Issueを作成してください．テンプレートがあるので基本的にはそれを利用してください．

How to edit exiting code and add new code コードの編集や追加の方法

GitHub-flowと呼ばれる方法を採用します．以下の流れです．

  1. Confirm related Issue. If there is no issue, create the issue. 対応するIssueの内容を確認する．ない場合はまずIssueを作成する
  2. Create a branch. ブランチを切る．
    • name issue number at prefix, compact representation about the work. ブランチ名はIssue番号を先頭につけて，そのあと作業内容を簡潔に書く．
  3. Push at an appropriate frequency. 適宜pushをする．
  4. Completing the work, create pull request. 作業がひと段落したらpull requestを出す．
    • Don't forget to write issue number. Issueの番号を必ず書いてください．
    • must request review to someone. レビューを必ず他の人に依頼すること．
    • Only doctors students can merge. Dの学生だけがマージが可能．

GitHub-flowに関してはこちらを参照してください．
GitHub Flow ～GitHubを活用するブランチモデル～

Note 諸注意

Libraries in this repository are made by every lab members. It is not a finished product without bugs. So do not use it as a black box as an end user would. Even for codes that are merged with master, please keep in mind there might be some bugs. Also, please create issues or features request topic. We are expecting your positive contribution !

このリポジトリにあるライブラリはあくまでラボメンバー皆で作って行くものです．バグのない完成したものではありません．なのでエンドユーザー感覚で完全にブラックボックスとして使わないでください．masterにマージされているライブラリでも，デバッグをやるぐらいの心づもりで利用してください．また，欲しい機能は自分で作ったりIssueで提案したり，積極的なcontributeを期待しています！

Clone this wiki locally