2つのチャットボット、2つのポートフォリオ
AIエンジニアのポートフォリオは、採用する側に見せる作品で、あなたの判断の仕方が伝わるものです。2人がそれぞれチャットボットを見せます。1人は画面のスクリーンショットだけです。もう1人は、評価の表、わかっている失敗の一覧、1週間の運用費用を見せます。
採用担当者が多くを知れるのは、2人目のほうです。このレッスンでは、総仕上げ演習から2人目のようなポートフォリオを作ります。
このレッスンのゴール
メモ
ポートフォリオの作品を、判断力が伝わるチェックリストで確かめられる。
今日のキーワード
| ことば | いみ |
|---|---|
| ポートフォリオ | 採用する側に見せる作品の集まりです。 |
| リポジトリ | プロジェクトのファイルと履歴を入れる場所です。 |
| README | 訪れた人が最初に読むファイルです。 |
| 既知の限界 | プロジェクトが苦手なことを、はっきり書いたものです。 |
| 再現できる | ほかの人が動かしても、同じ結果になることです。 |
学生が入力するセルは、このプレビューでは空白です。
READMEは、何を、なぜ、どう動かすか
訪れた人がリポジトリに使う時間は、1分か2分です。その時間を支えるのがREADMEです。
プロジェクトが何をするかを1文で書きます。なぜ作ったのか、だれのためかも書きます。次に、決まったサンプルデータを使った動かし方を数ステップで書き、再現できるようにします。評価の結果は、下のほうではなく上のほうに置きます。
例: READMEの見出し
| 見出し | その下に書くこと |
|---|---|
| 何をするか | 1文で: 40の社内規程から社員の質問に答える |
| なぜ作ったか | 困りごとと、それに困っている人 |
| 動かし方 | サンプルの文書付きで、3ステップ |
| 評価の結果 | 20問中18問正解、推測なし、実行した日付も |
| 既知の限界 | 長い文書では遅い、表についての質問を外す |
| 次にやること | 変更を1つか2つ、それぞれ理由を添えて |
学生が入力するセルは、このプレビューでは空白です。
証拠と限界が判断力を伝える
機能が動くと言うだけなら、だれにでもできます。証拠とは、ほかの人が確かめられる数字です。評価の点数、費用、レイテンシーです。
既知の限界も同じくらい大切です。どこで失敗するかを書けば、テストしたことが伝わります。次に何を直すかをわかっていることも伝わります。下のプログラムは、READMEの見出しをチェックリストと比べます。
やってみよう: READMEを確かめる
# 総仕上げ演習のREADMEにあった見出しです。
headings = ["何をするか", "動かし方", "評価の結果"]
checklist = [
"何をするか",
"なぜ作ったか",
"動かし方",
"評価の結果",
"既知の限界",
"次にやること",
]
missing = 0
for item in checklist:
if item in headings:
print("あり", item)
else:
print("なし", item)
missing = missing + 1
print(len(checklist), "項目のうち", missing, "項目がありません")
# headings に "既知の限界" を足して、もう一度実行しましょう。
安全で、正直で、自分のもの
リポジトリを公開する前に、3つを確かめます。秘密がないこと。キーやパスワードは、履歴のどこにも入れません。個人情報がないこと。架空の名前とサンプルの文書を使います。
そして自分のものであること。アシスタントが書いた部分を明かし、借りたコードには出どころを書きます。ライセンスを付けて、ほかの人が何をしてよいかを示します。
よくある誤解
注意
多くの人は、ポートフォリオにはうまくいったところだけを載せるべきだと考えます。失敗をすべて隠すと、テストをしていないように見えます。見る人が探しているのは判断力なので、既知の限界と次にやることを書きましょう。