チュートリアルの作成 #69

AZKZ · 2023-08-06T09:56:43Z

Pull request前の確認

フォークしたリポジトリのdevelopブランチ（あるいはそこから新たに切ったブランチ）にプッシュを行った。（mainブランチに直接プッシュしていない。）
プルリクエストでマージを要求するブランチをmainブランチからdevelopブランチに変更した。

概要

この Pull request はチュートリアルを作成しました
- 今後、使うことになりそうなので 小学生学年(Enum) を作成しました

動作確認

作成してGithub Pagesを自リポジトリで目視確認した
- https://azkz.github.io/OpenFisca-Japan/tutorial

netlify · 2023-08-06T09:56:49Z

✅ Deploy Preview for shien-yadokari canceled.

Name	Link
🔨 Latest commit	`a3cdd81`
🔍 Latest deploy log	https://app.netlify.com/sites/shien-yadokari/deploys/658b6e1a258e5700083fcb87

SnoozingJellyfish · 2023-11-04T08:24:59Z

docs/tutorial.md

+
+テストデータを作成するには下記の作業を実施します。
+
+1. テストパターンのCSVを作成する


「3の倍数給付金」おもしろいですね！一連の流れがわかると着手しやすくなりますね。

児童手当等はcsv -> yamlのテストファイル変換をしていたのですが、最近対象とした制度はロジックが複雑すぎるため、細かいステップごとの単体テストを全てyamlで直接作っています。（例：openfisca_japan/tests/福祉/生活保護）
そのため、CSVをyamlに変換する手順はなくても問題ありません。

netlify · 2023-11-28T11:29:41Z

✅ Deploy Preview for silly-gumption-65c982 canceled.

Name	Link
🔨 Latest commit	`16f19c8`
🔍 Latest deploy log	https://app.netlify.com/sites/silly-gumption-65c982/deploys/6572694cef78000008774c3d

…eate_tutorial

AZKZ · 2023-12-07T15:47:14Z

@SnoozingJellyfish

チュートリアルを作成したので、お手数ですがご確認をお願い致します！

SnoozingJellyfish

丁寧なチュートリアルありがとうございます！わかりやすく面白いですね。
いくつかコメントしています。 markdownでプルダウンができるのを初めて知りました。

@syupern さん、補足やより良い説明方法、修正した方が良い点等あればコメントお願いします！

docs/tutorial.md

SnoozingJellyfish · 2023-12-08T12:35:47Z

docs/tutorial.md

+    class 三の倍数給付金(Variable):
+        value_type = int # この給付金は小数にはならないので整数型のintを指定している
+        entity = 世帯 # この給付金は世帯ごとに支給されるので世帯を指定している
+        definition_period = DAY # 基本はDAYを指定する。※どういう時にYEARやMONTHを指定する？


YEARやMONTHの使い方はよくわかってないです。。

Variable間で期間を換算する必要が無いためDAYに揃えているのではないかと思います。

OpenFisca公式のドキュメントによると制度が定義されている期間を設定するものなので、それに倣うのが良さそうです。（年間10万円なので YEAR ？）
#184

SnoozingJellyfish · 2023-12-08T12:40:48Z

docs/tutorial.md

+        年齢が3の倍数の世帯員数 = np.count_nonzero(np.mod(世帯員の年齢一覧, 3) == 0)
+
+        # 3の倍数の世帯員の数×100,000円を返す
+        給付金額 = 年齢が3の倍数の世帯員数 * 100000


定数（100000円）をparameters/フォルダにyamlで定義する手順も記載お願いします！

SnoozingJellyfish · 2023-12-08T12:48:29Z

docs/tutorial.md

+        世帯員の年齢一覧 = 対象世帯.members("年齢", 対象期間)
+
+        # 3の倍数の世帯員の数を取得する
+        年齢が3の倍数の世帯員数 = np.count_nonzero(np.mod(世帯員の年齢一覧, 3) == 0)


OpenFiscaの推奨する書き方としては以下の感じです。

年齢が3の倍数である = 世帯員の年齢一覧 % 3 == 0 # 条件に該当するか否かのbool値のndarray配列ができる給付金額一覧 = 年齢が3の倍数である * (定数) # 世帯員ごとに給付される額が格納されたndarray配列ができる給付金額 = 対象世帯.sum(給付金額一覧) # numpy の関数はできるだけ使わないことが望ましい

docs/tutorial.md

SnoozingJellyfish · 2023-12-08T12:57:15Z

docs/tutorial.md

+        世帯員の学年一覧 = 対象世帯.members("学年", 対象期間)
+
+        # ボーナス対象学年の世帯員数を取得する
+        ボーナス対象学年の世帯員数 = np.count_nonzero(np.isin(世帯員の学年一覧, [小学生学年.三年生.value,小学生学年.六年生.value,中学生学年.三年生.value, 高校生学年.三年生.value]))


Openfisca推奨の書き方は以下の感じです。

小学三年生である = 世帯員の学年一覧 == 小学生学年.三年生.value # 条件に該当するか否かのbool値のndarray配列ができる小学六年生である = 世帯員の学年一覧 == 小学生学年.六年生.value 中学三年生である = 世帯員の学年一覧 == 中学生学年.三年生.value 高校三年生である = 世帯員の学年一覧 == 高校生学年.三年生.value ボーナス対象学年である = 小学三年生である + 小学六年生である + 中学三年生である + 高校三年生である # OpenFiscaでは or の代わりに + を用います給付金額一覧 = 年齢が3の倍数である * (定数) + ボーナス対象学年である * (定数) # 世帯員ごとに給付される額が格納されたndarray配列ができる給付金額 = 対象世帯.sum(給付金額一覧) # numpy の関数はできるだけ使わないことが望ましい

SnoozingJellyfish · 2023-12-08T13:00:37Z

docs/tutorial.md

+    ```
+
+2. コンテナを再ビルドできたら、下記のcurlコマンドで `/calculate` にPOSTリクエストを送る
+   - レスポンスの3の倍数給付金に金額が入っていることを確認する


docker compose が起動した状態で http://localhost:8080 にアクセスするとSwagger-UIが使えるので、そちらのGUIでPOSTする方が簡単かもしれません。

Syuparn · 2023-12-09T08:24:39Z

docs/tutorial.md

+                  "ETERNITY": "1979-01-01"
+              }
+          },
+          "子ども0": {


(細かいですが...)テストの表記に合わせて 子1 にすると分かりやすいかなと思いました。

docs/tutorial.md

…eate_tutorial

SnoozingJellyfish

修正ありがとうございます！
細かい点ですがいくつか追加コメントしています。
チュートリアルのファイルを作るとうっかりプッシュしてしまうかもしれないので、variables, parameters, testsのそれぞれチュートリアルフォルダ以下を .gitignore に追加してもいいかもしれません。

docs/tutorial.md

SnoozingJellyfish · 2023-12-24T12:47:27Z

docs/tutorial.md

+
+### 1. ボーナス金額のパラメーターファイルを作成する
+
+1. 下記の内容で`parameters/チュートリアル/3の倍数給付金額_ボーナス.yaml` のファイルを作成する


parameters/チュートリアル/三の倍数給付金額_ボーナス.yaml (漢数字)の誤記だと思うので修正お願いします！

別のターミナルで docker compose up --build を実行している状態でないと docker compose exec openfisca /bin/bash コマンドが多分実行できないので、その旨記載お願いします🙏

補足説明を追記しました。

parameters/チュートリアル/三の倍数給付金額_ボーナス.yaml (漢数字)の誤記だと思うので修正お願いします！

漢数字に修正しました。

AZKZ · 2023-12-26T12:55:21Z

@SnoozingJellyfish @Syuparn

ご確認いただきありがとうございます！
指摘いただいた内容を修正したので、お手好きの際にご確認をお願いします！

Syuparn · 2023-12-26T23:21:07Z

docs/index.md

@@ -23,4 +23,6 @@
 - [Google_custom_search_APIについて](./chat_bot.md#google_custom_search_apiについて)
 - [miiboについて](./chat_bot.md#miiboについて)

+### [チュートリアル](./tutorial)


(前回のレビューで気づけなかったのですが 🙏 )ここのリンクが切れてしまっているので修正お願いします。

Suggested change

### [チュートリアル](./tutorial)

### [チュートリアル](./tutorial.md)

Syuparn · 2023-12-26T23:22:01Z

docs/index.md

@@ -23,4 +23,6 @@
 - [Google_custom_search_APIについて](./chat_bot.md#google_custom_search_apiについて)
 - [miiboについて](./chat_bot.md#miiboについて)

+### [チュートリアル](./tutorial)
+
 ### [変更履歴 (Change log)](./change_log)


今回の改修と関係ないのですが、忘れないうちにこちらのリンク切れも修正いただけるとありがたいです。

Suggested change

### [変更履歴 (Change log)](./change_log)

### [変更履歴 (Change log)](./change_log.md)

Syuparn · 2023-12-26T23:25:25Z

@AZKZ
リンクが切れていた箇所を追加でコメントしましたのでご確認お願いします。それ以外は問題ないと思います！

AZKZ · 2023-12-27T00:23:18Z

@Syuparn

ご確認ありがとうございます！
Github Pages上では.mdはなくても画面遷移できるようでしたが、他と合わせるという意味でも修正いたしました！

Syuparn · 2023-12-27T00:34:07Z

修正ありがとうございます！内容良いと思います！

@SnoozingJellyfish
確認いただいて問題なければマージお願いします。

SnoozingJellyfish · 2023-12-27T12:39:11Z

修正・レビューありがとうございます！確認できたのでマージします。
これでぐっとOpenFiscaに取り組みやすくなると思います！

SnoozingJellyfish reviewed Nov 4, 2023

View reviewed changes

AZKZ force-pushed the #48_create_tutorial branch from 6442f40 to 4c1f5ef Compare November 28, 2023 11:29

AZKZ added 3 commits November 28, 2023 20:33

Merge branch 'develop' of github.com:AZKZ/OpenFisca-Japan into #48_cr…

8a169a8

…eate_tutorial

チュートリアルの内容を一通り作成した。

b48d812

チュートリアルのmarkdownを微修正した

1244bb4

AZKZ force-pushed the #48_create_tutorial branch 3 times, most recently from 0143bcb to 20f2a27 Compare December 7, 2023 15:35

チュートリアルのmarkdownを微修正した

37919d6

AZKZ force-pushed the #48_create_tutorial branch from 20f2a27 to 37919d6 Compare December 7, 2023 15:41

AZKZ changed the title ~~【編集中】チュートリアルの作成~~ チュートリアルの作成 Dec 7, 2023

AZKZ marked this pull request as ready for review December 7, 2023 15:46

チュートリアルのmarkdownを微修正した

16f19c8

SnoozingJellyfish reviewed Dec 8, 2023

View reviewed changes

Syuparn reviewed Dec 9, 2023

View reviewed changes

SnoozingJellyfish reviewed Dec 10, 2023

View reviewed changes

docs/tutorial.md Show resolved Hide resolved

AZKZ added 2 commits December 19, 2023 20:50

Merge branch 'develop' of github.com:AZKZ/OpenFisca-Japan into #48_cr…

34b6a7f

…eate_tutorial

PRで指摘いただいた内容の修正

2296e81

SnoozingJellyfish reviewed Dec 24, 2023

View reviewed changes

レビューで追加指摘を頂いた内容の修正

2e56774

AZKZ requested review from Syuparn and SnoozingJellyfish December 26, 2023 12:54

Syuparn reviewed Dec 26, 2023

View reviewed changes

リンクのURLの統一化

a3cdd81

SnoozingJellyfish merged commit 67503e7 into project-inclusive:develop Dec 27, 2023
6 checks passed

AZKZ mentioned this pull request Mar 4, 2024

OpenFisca開発に関するオンボーディングドキュメント作成する #48

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

チュートリアルの作成 #69

チュートリアルの作成 #69

AZKZ commented Aug 6, 2023 •

edited

Loading

netlify bot commented Aug 6, 2023 •

edited

Loading

SnoozingJellyfish Nov 4, 2023

netlify bot commented Nov 28, 2023 •

edited

Loading

AZKZ commented Dec 7, 2023

SnoozingJellyfish left a comment

SnoozingJellyfish Dec 8, 2023

Syuparn Dec 9, 2023 •

edited

Loading

SnoozingJellyfish Dec 8, 2023

SnoozingJellyfish Dec 8, 2023

SnoozingJellyfish Dec 8, 2023

SnoozingJellyfish Dec 8, 2023

Syuparn Dec 9, 2023

SnoozingJellyfish left a comment

SnoozingJellyfish Dec 24, 2023

AZKZ Dec 26, 2023

AZKZ commented Dec 26, 2023

Syuparn Dec 26, 2023

Syuparn Dec 26, 2023

Syuparn commented Dec 26, 2023

AZKZ commented Dec 27, 2023

Syuparn commented Dec 27, 2023

SnoozingJellyfish commented Dec 27, 2023


		テストデータを作成するには下記の作業を実施します。

		1. テストパターンのCSVを作成する


		### 1. ボーナス金額のパラメーターファイルを作成する

		1. 下記の内容で`parameters/チュートリアル/3の倍数給付金額_ボーナス.yaml` のファイルを作成する

	### [チュートリアル](./tutorial)
	### [チュートリアル](./tutorial.md)

	### [変更履歴 (Change log)](./change_log)
	### [変更履歴 (Change log)](./change_log.md)

チュートリアルの作成 #69

チュートリアルの作成 #69

Conversation

AZKZ commented Aug 6, 2023 • edited Loading

Pull request前の確認

概要

動作確認

netlify bot commented Aug 6, 2023 • edited Loading

✅ Deploy Preview for shien-yadokari canceled.

Choose a reason for hiding this comment

netlify bot commented Nov 28, 2023 • edited Loading

✅ Deploy Preview for silly-gumption-65c982 canceled.

AZKZ commented Dec 7, 2023

SnoozingJellyfish left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Syuparn Dec 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SnoozingJellyfish left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AZKZ commented Dec 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Syuparn commented Dec 26, 2023

AZKZ commented Dec 27, 2023

Syuparn commented Dec 27, 2023

SnoozingJellyfish commented Dec 27, 2023

AZKZ commented Aug 6, 2023 •

edited

Loading

netlify bot commented Aug 6, 2023 •

edited

Loading

netlify bot commented Nov 28, 2023 •

edited

Loading

Syuparn Dec 9, 2023 •

edited

Loading