Support to log external artifacts [need feedback and review] #44
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
External artifacts are artifacts that are not managed by CMF, instead, by external tracking platforms such as MLflow or AIM. The commit adds the following method to the `Cmf`:
```python
def log_reference(self, uri: str, event: str, custom_properties: t.Optional[t.Dict] = None) -> mlpb.Artifact:
...
```
where the key parameter is the `uri` that points to this external artifact. Examples of such URIs are:
```
mlflow:///runs/RUN_ID/mnist.npz
mlflow:///models/cdu01/production
aim://run/RUN_HASH
```
sergey-serebryakov
requested review from
annmary-roy,
atripathy86,
martin-foltin and
suparna-bhattacharya
sergey-serebryakov
changed the title
Resolving conflicts (cmflib/cmf.py).
sergey-serebryakov
changed the title
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.
External artifacts are artifacts that are not managed by CMF, instead, by external tracking platforms such as MLflow or AIM. The commit adds the following method to the
Cmf:where the key parameter is the
urithat points to this external artifact. Examples of such URIs are:Several architectural decisions still need to be made. In particular, CMF already defines several and uses several types of artifacts, such as
DatasetandModel. These external references currently have their own typeReference. On problem here is that these references can and will point to models and datasets. So, CMF may end up using several artifact types for the same entities. As an alternative implementation, existing implementations of the following methods (log_datasetandlog_model) maybe updated to be able to log both internal and external artifacts, and method proposed in this commit (log_reference) could be renamed to something likelog_artifactwhere users can log non-standard artifact types (which ism probably, not a very good idea).