Skip to content

Commit 8c33623

Browse files
yuta-nakaharayuta-nakahara
committed
Initial commit
0 parents  commit 8c33623

File tree

107 files changed

+18162
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+18162
-0
lines changed

‎.gitignore

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
doc/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
# Manually added
132+
*.npz
133+
*.npy
134+
*.pdf
135+
*.dot
136+
*.pkl
137+
*.gv
138+
.DS_Store

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
bayesml.developer@gmail.com.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!--
2+
Document Author
3+
Yuta Nakahara <yuta.nakahara@aoni.waseda.jp>
4+
Shota Saito <shota.s@gunma-u.ac.jp>
5+
-->
6+
# How to contribute
7+
8+
We appreciate your consideration of contributing to BayesML and your visit to this page.
9+
This page describes how to report bugs, correct and translate the documents, and contribute to the codes.
10+
11+
## History and philosophy of BayesML
12+
13+
First, we would like you to understand the release history and philosophy of BayesML. As described in README.md, the purpose of BayesML is to promote research, education, and application of machine learning based on Bayesian statistics and Bayesian decision theory. Through these activities, BayesML aims to widely contribute to society. BayesML originally attempted to unify the private implementation of code regarding Bayesian machine learning in our laboratory to improve the efficiency of educational activity. However, this attempt may be useful for other researchers, students, and data scientists working for a company. Therefore, we decided to release BayesML.
14+
15+
Because of this history, BayesML places great emphasis on the educational aspect. We hope all users and contributors deepen their understanding of Bayesian statistics and machine learning based on Bayesian decision theory through their interactions with BayesML. We also hope that they apply the deepened knowledge to academia, industry, and other areas of society. All the contributions to BayesML are reviewed under this philosophy. If your contribution is not accepted, it is a difference of opinion and does not negate the value of your contribution.
16+
17+
Also, please read this [code of conduct](./CODE_OF_CONDUCT.md).
18+
19+
## How to report a bug
20+
21+
If you find a bug, please create an issue in the following format.
22+
23+
* Execution environment
24+
* OS
25+
* Python and library versions
26+
* Execution content
27+
* Expected results
28+
* Actual results
29+
30+
## How to correct and translate the documents
31+
32+
Regarding minor issues such as typos and grammatical errors, please create an issue in the following format.
33+
34+
* URL
35+
* Incorrect description
36+
* Correct description
37+
38+
If you can cooperate with major revisions or translations, please contact us through the creation of an issue in any format. In particular, because most of the documents for developers are written in Japanese, we welcome anyone who can translate these materials.
39+
40+
## How to contribute to the codes
41+
42+
We are sorry, but we do not accept contributions to the codes from people who are not acquaintances with developers. The main reasons are as follows.
43+
44+
* The implementation format of the variational Bayes algorithm to be implemented in the future is not unified.
45+
* The documents for developers are not prepared.
46+
* The developers are not familiar with the development of an OSS project.
47+
48+
When these issues are resolved, we would be happy to receive your contributions to the codes. In that case, we would like you to understand that it may be necessary to discuss your contribution based on the development philosophy of BayesML.

‎CONTRIBUTING_jp.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<!--
2+
Document Author
3+
Yuta Nakahara <yuta.nakahara@aoni.waseda.jp>
4+
-->
5+
# コントリビューションの方法
6+
7+
まず，BayesMLへのコントリビューションを考え，このページを訪れてくださったことに心から感謝いたします．
8+
このページでは，バグの報告，ドキュメントの修正・翻訳，コードへの貢献方法について記載します．
9+
10+
## BayesMLの公開経緯と理念
11+
12+
はじめに，BayesMLの立ち上げの経緯と理念をご確認ください．BayesMLの目的は，README.mdにあるように，ベイズ統計学やベイズ決定理論に基づく機械学習の研究，教育，活用を促進し，社会に広く貢献することです．BayesMLは，もともと我々の研究室の後輩指導を効率化するためにベイズ機械学習に関するコードの実装形式を統一しようという試みでした．しかし，この試みは他の研究者，学生，企業に勤めるデータサイエンティストにとっても有用かもしれません．そこで，BayesMLを公開することにしました．
13+
14+
こうした経緯があるため，BayesMLでは教育的な側面を非常に重視しています．我々は，利用者，コントリビュータの皆さんがBayesMLとの関わりの中でベイズ統計学，ベイズ決定理論に基づく機械学習に対する理解を深め，それを学術界や産業界など社会の様々な場所に活用してくれることを願っています．BayesMLに対するあらゆるコントリビューションはこの理念のもとにレビューされます．もし仮にあなたのコントリビューションが採用されなかったとしても，それは考え方の相違であって，コントリビューションそのものの価値を否定するものではないということをご理解いただければ幸いです．
15+
16+
また，[こちら](./CODE_OF_CONDUCT.md)の行動規範についてもご一読ください．
17+
18+
## バグの報告方法
19+
20+
バグを発見された方は，以下の形式でイシューの作成をお願いいたします．
21+
22+
* 実行環境
23+
* OS
24+
* Pythonやライブラリのバージョン
25+
* 実行内容
26+
* 期待された結果
27+
* 実際の結果
28+
29+
## ドキュメントの修正・翻訳方法
30+
31+
タイポや文法上の誤りなどの軽微なものについては，以下の形式でイシューの作成をお願いいたします．
32+
33+
* URL
34+
* 誤った記述
35+
* 正しい記述
36+
37+
大規模な修正，翻訳にご協力頂ける方は，形式は指定しませんのでイシューの作成を通じてご連絡ください．特に，開発者向けの資料の大部分は日本語で執筆されているため，これらの翻訳をお願いできる方を歓迎いたします．
38+
39+
## コードへの貢献方法
40+
41+
申し訳ございませんが，現在，開発者と直接面識のない方からのコードへの貢献は受け付けておりません．主な理由は以下の通りです．
42+
43+
* 今後，実装予定の変分ベイズ系アルゴリズムの実装形式が統一されていない
44+
* 開発者向けのドキュメントが整備されていない
45+
* 開発者がOSSプロジェクトとしての開発に不慣れである
46+
47+
これらの問題が解決され次第，コードへの貢献を募集させていただければと思います．その場合にも，BayesMLの開発理念に基づく議論が必要となる可能性があるということをご了承いただければと思います．

‎LICENSE.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2022, BayesML Developers.
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
1. Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
3. Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

0 commit comments

Comments
 (0)