Welcome to Python Citrination Client’s documentation!¶
Use the articles in this section to familiarize yourself with the basic usage of the Python Citrination Client.
If you are using a version of PyCC older than 6.0.0 and would like to upgrade your scripts to the latest versions, please note the following:
Changes from 4.x to 5.x¶
When building data views, you now have to specify upper and lower bounds.
When making certain prediction/design calls, things previously under
client.data_viewsare now under
You have to specify the subclient, e.g.
Changes from 5.x to 6.x¶
Custom Ingester Support - allows for the usage of custom ingesters when uploading files. See
Model Reports - first pass access to
feature importances, and
model performance metricsfor data views with ML configured. See
Version 6.1.0 adds pif_version support on
DataClient#get_pif, and a new method
Version 6.2.0 adds
ViewsClient#get_relation_graphfor retrieving relation graphs from data views with ML configured
Version 6.3.0 adds the
AdvancedDataViewBuilderclass, a more expressive interface for building data views with machine learning.
Version 6.4.0 adds a
class_probabilitiesdict to prediction responses and support for simplifying building formulation views
The ModelsClient.get_data_view method has been deprecated in favor of ViewsClient.get.
The DataView class has been removed - it was previously only used by
Error message propagation for 404 errors - this should give more friendly error messages when resources being acted upon are not found. For example instead of the generic
Resource Not Foundmessage, one might get a
Dataset 1234 was not foundmessage.
Version 6.3.0 modifies the
ViewsClient#updatemethod signature, making all of the arguments optional (previously you had to always provide name, description, and configuration).
If you already have
citrination-client installed (either in your virtual environment or your global set of
pip packages), you can upgrade to v6.x like this:
pip install --upgrade citrination-client
If you do this in an existing project, be sure to update your
requirements.txt file to point to version 6.0.0 or newer.