Skip to content

Develop devdoc #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 15, 2022
Merged

Develop devdoc #36

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e75d31d
Update docstring_rule.md
yuta-nakahara Nov 15, 2022
839db19
Update docstring_rule.md
yuta-nakahara Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/devdoc/docstring_rule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
xxx : float or numpy.ndarray, optional
Real numbers,
by default [0.0, 0.0, ... , 0.0]
If a single scaler is input, it will be broadcasted.
If a single real number is input, it will be broadcasted.
```

#### 非負の実数の組
Expand All @@ -423,7 +423,7 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
xxx : float or numpy.ndarray, optional
Non-negative real numbers,
by default [1.0, 1.0, ... , 1.0]
If a single scaler is input, it will be broadcasted.
If a single real number is input, it will be broadcasted.
```

#### 正の実数の組
Expand Down Expand Up @@ -518,7 +518,7 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
```
xxx : numpy.ndarray, optional
Vectors of real numbers,
by default zero vectors.
by default zero vectors
If a single vector is input, will be broadcasted.
```

Expand All @@ -527,7 +527,7 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
```
xxx : numpy.ndarray, optional
Vectors of non-negative numbers,
by default vectors whose elements are all 1.
by default vectors whose elements are all 1.0
If a single vector is input, will be broadcasted.
```

Expand All @@ -536,7 +536,7 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
```
xxx : numpy.ndarray, optional
Vectors of positive numbers,
by default vectors whose elements are all 1.
by default vectors whose elements are all 1.0
If a single vector is input, will be broadcasted.
```

Expand All @@ -546,7 +546,7 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
xxx : numpy.ndarray, optional
Vectors of real numbers in :math:`[0, 1]`,
by default vectors such as [1/yyy, 1/yyy, ... , 1/yyy]
Sum of the elements of each vector must be 1.
Sum of the elements of each vector must be 1.0.
If a single vector is input, will be broadcasted.
```

Expand All @@ -566,7 +566,7 @@ class LearnModel(base.Posterior,base.PredictiveMixin):
xxx : numpy.ndarray, optional
A matrix of real numbers in :math:`[0, 1]`,
by default a matrix obtained by stacking [1/yyy, 1/yyy, ... , 1/yyy]
Sum of the elements of each row vector must be 1.
Sum of the elements of each row vector must be 1.0.
If a single vector is input, will be broadcasted.
```

Expand Down