Netflix/metaflow

Support auto-completion of Metaflow objects/API in notebooks

Closed

#1,114 opened on Aug 18, 2022

View on GitHubContributor guide
 (9 comments) (2 reactions) (0 assignees)Python (695 forks)batch import
enhancementhelp wantedupforgrabs

Repository metrics

Stars
 (7,202 stars)
PR merge metrics
 (Avg merge 31d 18h) (23 merged PRs in 30d)

Description

We could support some form of auto-completion for Metaflow in iPython. Some examples:

def _ipython_key_completions_(self):
    return [s.id for s in self.steps()]

on a run to complete something like my_run['<tab>

Details on the possibilities here: https://ipython.readthedocs.io/en/stable/config/integrating.html#tab-completion

Contributor guide

Research direction
Implement ` ipython key completions ` method on the Metaflow `Run` class to enable tab completion for step IDs in IPython. Refer to the linked IPython documentation for integration details. Check existing comments for any proposed API or implementation considerations. The method should return a list of step IDs from `self.steps()`.
Tech stack
python
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonIPython tab completion APIMetaflow API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75