Netflix/metaflow

Support auto-completion of Metaflow objects/API in notebooks

Geschlossen

#1.114 geöffnet am 18.08.2022

Auf GitHub ansehenContributor Guide
 (9 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Python (695 Forks)batch import
enhancementhelp wantedupforgrabs

Repository-Metriken

Stars
 (7.202 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 31T 18h) (23 gemergte PRs in 30 T)

Beschreibung

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-Richtung
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
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonIPython tab completion APIMetaflow API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75