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.20220304142108
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| akerbp.models-1.20220304142108.tar.gz | 28.4 kB | Without provenance | Details for akerbp.models-1.20220304142108.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| akerbp.models-1.20220304142108-py3-none-any.whl | Python 3 | none | any | Details for akerbp.models-1.20220304142108-py3-none-any.whl |
Total release size: 67.5 kB
Release files / akerbp.models-1.20220304142108.tar.gz
| Download URL | akerbp.models-1.20220304142108.tar.gz |
|---|---|
| Size | 28.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
680a8ca9f5916ffdc482379f0f4e8094ac6f2da693bea9e82c5a2f5de439f81d
|
|
BLAKE2b-256 checksum How to use checksums |
b0bcf49b81ea279e50afb261784a07f382020ab0a66f6b18b6274908892b8d81
|
| 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.20220304142108-py3-none-any.whl
| Download URL | akerbp.models-1.20220304142108-py3-none-any.whl |
|---|---|
| Size | 39.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
73d00f36181e11878811150736508882267bf00d276e606cd96d540d64607aac
|
|
BLAKE2b-256 checksum How to use checksums |
e653fbbc6d1cb907b09acafc0533f35226a40248cba4282d1ac2fd8f523f84df
|
| 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.20220304142108
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.