Skip to content

Commit 8f57fee

Browse files
authored
Merge pull request #942 from CitrineInformatics/docs/update_descriptor_method_ref
Docs/update descriptor method ref
2 parents e11f3a5 + 365c230 commit 8f57fee

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/source/formulations_example.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -564,8 +564,8 @@ We also use ``blend time`` as an input.
564564
565565
Where did the descriptor keys ``margarita~blend time`` and ``margarita~tastiness`` come from?
566566
They came from concatenating the headers in the variables in the table, and the bounds and units came from the attribute templates.
567-
It's a lot to keep track of, which is why there is the :func:`~citrine.resources.descriptors.DescriptorMethods.descriptors_from_data_source` method.
568-
Calling ``project.descriptors.descriptors_from_data_source(data_source)`` returns a list of all of the descriptors emitted by the data source.
567+
It's a lot to keep track of, which is why there is the :func:`~citrine.resources.descriptors.DescriptorMethods.from_data_source` method.
568+
Calling ``project.descriptors.from_data_source(data_source)`` returns a list of all of the descriptors emitted by the data source.
569569
Make sure that these are the descriptors you are using as inputs to your predictor.
570570

571571

docs/source/workflows/predictors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Both binary and multi-class classification are supported automatically based on
3838
Models are trained using data provided by a :class:`~citrine.informatics.data_sources.DataSource` specified when creating a predictor.
3939
The inputs and outputs are descriptors, which must correspond precisely to descriptors that exist in the training data or are produced by other predictors in the graphical model.
4040
There are two important helper methods in this regard.
41-
:func:`~citrine.resources.descriptors.DescriptorMethods.descriptors_from_data_source` can provide all of the descriptors that are present in the training data.
41+
:func:`~citrine.resources.descriptors.DescriptorMethods.from_data_source` can provide all of the descriptors that are present in the training data.
4242
:func:`~citrine.resources.descriptors.DescriptorMethods.from_predictor_responses` can tell you what the outputs of a predictor will be, which is especially useful for featurizers.
4343

4444
The following example demonstrates how to use the Citrine Python client to create an :class:`~citrine.informatics.predictors.auto_ml_predictor.AutoMLPredictor`, register the predictor to a project and wait for validation:

src/citrine/__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "3.2.10"
1+
__version__ = "3.2.11"

0 commit comments

Comments
 (0)