Carrier Owl

伝書フクロウという意味です。

About Carrier Owl

前日のarxivから気になる論文にスコアを付けてslackに通知するシステムです。
通知の際に、abstractをDeepLで翻訳しています。
導入に必要なのはgithubアカウントだけです。10minぐらいで設定は終わります！！
スコアは、ターゲットとなるキーワードに重み付けをして決まります。(例 resnet=5, kaggle=3, audio=3)
ユーザーが好きな領域、好きなキーワードを登録することで、通知される論文は変わります。

登録キーワード例

keywords:
    sound: 1
    audio: 1
    sound feature: 3
    audio feature: 3
    noise removal: 2
    spectrogram: 3

通知例(score昇順)

Installation

step

このリポジトリをフォークする
webhook urlの取得
- 特定のslackチャンネルに流すための準備を行います。
- incomming webhookのwebhook urlを取得してください。
  - 参考サイト
    - 公式
    - 紹介記事
- slack通知の時のアイコンが設定できますので、よければこれ使ってください。
  - icon
webhook urlの設定
- 2で取得した webhook url を設定します。
- 手順
  
  a. settings をクリック。
  
  b. Secrets をクリック。 c. New repository secret をクリック。
  
  d. Nameを SLACK_ID と入力。Valueを step2 で取得したwebhook urlを貼り付けます。
  
  e. 最後にAdd secretをクリックして登録完了です。
領域の設定
- 通知させたいarxivの論文の領域を指定します。
- (computer scienceの人はこの手順を飛ばしてstep8に進んでも構いません)
- computer science なら cs などそれぞれに名前がついています。以下の手順で確認します。
- 手順
  1. arxiv.orgにアクセス
  2. 通知させたい領域のresentと書かれた部分をクリック。
  3. 遷移後のページのurlを見て、list/と/recentに囲われている文字列を使います。
    - computer scienceの例: https://arxiv.org/list/cs/recent
    - この場合、cs をこの後利用する。
  4. config.yaml 内の、subject を3で取得した文字列に変更します。(デフォルトではcsになっています。)
キーワードの設定
- config.yaml にキーワードとそのキーワードのスコアを設定します。
- 例(音に関する論文を通知してほしい場合)
```
keywords:
    sound: 1
    audio: 1
    sound feature: 3
    audio feature: 3
    noise removal: 2
    spectrogram: 3
```
- 仕組みとしては、以下のような感じです。
  1. abstractにキーワードが含まれているか
  2. 含まれていれば、キーワードの合計をscoreとし、昇順で通知
通知タイミングの調整
- デフォルト設定では、日本時間の平日9時50分に通知されるようになっています。この設定で問題ない方はこれで設定完了です。
- 通知タイミングのカスタマイズは、こちらを変更することで可能です。
push
- ここまでの変更がmasterブランチに反映されていれば、これですべての設定が完了したことになります。次の通知タイミングでslackに通知されます。
test
- 試しに動かしてみたい場合は、master ブランチから test-send-to-slack ブランチを作成してください。test-send-to-slack ブランチが作られるとgithub actionsが走って問題なければ通知されるはずです。
- Actionsタブで様子を確認できます。

Thanks

hppさんのお力をお借りして、v2.0.0から github だけで動作するようになりました。ご協力ありがとうございました。

toyofumi-yamauchi/Carrier-Owl

Carrier Owl

About Carrier Owl

Installation

Thanks