Skip to content

Commit

Permalink
Add beta warnings to the docs
Browse files Browse the repository at this point in the history
Signed-off-by: Johannes Mueller <[email protected]>
  • Loading branch information
johannes-mueller committed Feb 22, 2022
1 parent 3b62978 commit fb01a14
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 7 deletions.
9 changes: 9 additions & 0 deletions src/pylife/materialdata/woehler/bayesian.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.


__author__ = "Mustapha Kassem"
__maintainer__ = "Johannes Mueller"

Expand All @@ -27,6 +28,14 @@


class Bayesian(Elementary):
"""A Wöhler analyzer using Bayesian optimization
Warning
-------
We are considering switching from pymc3 to GPyOpt as calculation engine in the
future. Maybe this will lead to breaking changes without new major release.
"""

class _LogLike(tt.Op):
"""
Expand Down
13 changes: 11 additions & 2 deletions src/pylife/stress/frequencysignal.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,20 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""A module for frequency signal handling
Warning
-------
This module is not considered finalized even though it is part of pylife-2.0.
Breaking changes might occur in upcoming minor releases.
"""

import numpy as np
import pandas as pd
from scipy import optimize as op


class psdSignal:
'''Handles different routines for self signals
Expand Down Expand Up @@ -94,4 +103,4 @@ def psd_smoother(self,fsel,factor_rms_nodes = 0.5):
args=(df_in,fsel,factor_rms_nodes))
opt_df[colact] = 10**np.interp(fout,fsel,np.log10(Hi.x))
opt_df.index = fout
return opt_df
return opt_df
15 changes: 10 additions & 5 deletions src/pylife/stress/timesignal.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""A module for time signal handling
Warning
-------
This module is not considered finalized even though it is part of pylife-2.0.
Breaking changes might occur in upcoming minor releases.
"""

__author__ = "Johannes Mueller"
__maintainer__ = __author__

Expand All @@ -34,11 +43,7 @@
class TimeSignalGenerator:
r"""Generates mixed time signals
The generated time signal is a mixture of random sets of
* sinus signals
* gauss signals (not yet)
* log gauss signals (not yet)
The generated time signal is a mixture of random sets of sinus signals
For each set the user supplys a dict describing the set::
Expand Down

0 comments on commit fb01a14

Please sign in to comment.