Skip to main content

AkerBP.models

Machine Learning Models for Petrophysics.

  • Classification Models
    • Wrapper for XGBoost classifier
    • Hierarchical and nested models for lithology (outdated)
  • Regression Models
    • Wrapper for XGBoost regressor
  • Rule-based models - several methods for badlog detection, including:
    • Crossplots outlier detection (supported: OCSVM, Elliptic envelope and Isolation Forest)
    • Logtrend, outliers, DENC and washout (based on the crossplots above)
    • Flatline
    • Resistivities
    • Casing
    • UMAP 3D segmentation
    • crosscorrelation

How to use

Example of how to use the badlog model class.

    import akerbp.models.rule_based_models as models
    # instantiate a badlog model object
    model = models.BadlogModel()

    # define which methods to run for badlog detection and run prediction
    # on data from one well
    methods = ['casing', 'flatline', 'dencorr', 'logtrend']
    model_predictions = model.predict(
        df_well,
        methods=methods,
        settings=None,
        mappings=None,
        folder_path=None
    )

Example of how to use the regression model class (wrapper of XGBoost).

    import akerbp.models.regression_models as models
    # instantiate an XGBoost regression model object with parameters as model_settings
    reg_model = models.XGBoostRegressionModel(
        settings=model_settings,
        model_path=folder_path
    )
    results = reg_model.predict(df_well)
    reg_model.save()  # it saves the model to specified folder path

This library is closely related and advised to be used together with akerbp.mlpet, also developed by AkerBP.

Rule-based models

The dataframe returned from running predictions on data from one well will contain new columns named in the following format "TYPE_METHOD_VAR", where:

  • TYPE: either "flag" or "agg". Flag can be 0 or 1 for regular or badlog samples respectively. Agg is the aggregation type, or score. It indicates how anomalous is the sample (used as a way for the user to set thresholds per method).
  • METHOD: method for the column flag. It should be as in the methods given to the predictions. An exception is the crossplots method, that will instead have [vpden, vpvs, aivpvs] as output method column names.
  • VAR: variable or curve that the column flags. It should be one of the following: den, ac, acs, rmed, rdep, rmic, calib_bs (one column only).

License

AkerBP.models Copyright 2021 AkerBP ASA

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, 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.

Metadata

Release files for akerbp.models 1.20220131200741

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for akerbp.models 1.20220131200741
File Size Uploaded Provenance Actions
akerbp.models-1.20220131200741.tar.gz 26.5 kB Without provenance Details for akerbp.models-1.20220131200741.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for akerbp.models 1.20220131200741
File Interpreter ABI Platform Actions
akerbp.models-1.20220131200741-py3-none-any.whl Python 3 none any Details for akerbp.models-1.20220131200741-py3-none-any.whl

Total release size: 63.0 kB

Release files / akerbp.models-1.20220131200741.tar.gz

Download URL akerbp.models-1.20220131200741.tar.gz
Size 26.5 kB
Tags Source
SHA-256 checksum
How to use checksums
412bfeec3dc5ef7bd894a0fefdb3644b805d472ecadb3cd331fe957827747958
BLAKE2b-256 checksum
How to use checksums
8a9f16cb3e7ce2d5cf9d73aee9e1c7ba5b495e63629c417e5e5b04be6027903c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.1 requests/2.26.0 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release files / akerbp.models-1.20220131200741-py3-none-any.whl

Download URL akerbp.models-1.20220131200741-py3-none-any.whl
Size 36.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6b61ad91b552609a9ba19ab13043f4ab2dfa7aa9a88927dac2dfb57171207ae
BLAKE2b-256 checksum
How to use checksums
8875fb024d2d7c1d1c9cef42e76435cf18e6f7bec9302d114e52bd535f1c6f2f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.1 requests/2.26.0 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Security for akerbp.models 1.20220131200741

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page