Add export of Pipeline YAML config #1003
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oryx1729
force-pushed
the
export-pipeline-yaml
branch
from
c6006d9
to
7d6f681
Compare
oryx1729
changed the title
tholor
requested changes
Apr 29, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Imlementation
This PR adds an
export_to_yaml()method for the Pipeline class to create a YAML configuration for a loadedPipelineinstance.Under-the-hood, the
BaseComponentsaves the init parameters used to create a Component. These parameters are put together inexport_to_yaml()to create the complete Pipeline config.Limitations
With this implementation, the init parameters are captured. Hence, any updates to a Component after it has been initialized are not reflected in the YAML.
Alternate approach
An alternative approach to generating the YAML by taking a snapshot of instance attributes of Components when calling
export_to_yaml()was also considered. With this approach, when export is called, we iterate over all the instance attributes of Components & filters the ones that are parameters in the corresponding init() of the Component. However, it might not work in case when init parameters likeembedding_model: strgets loaded asself.embedding_model: Inferencer. Additionally, some init parameters likeverify_certsin ElasticsearchDocumentStore are never saved as instance attributes.Resolves #741.