molabel

https://koaning.github.io/molabel/
Admin
molabel is an anywidget library that provides interactive annotation widgets for Python notebooks...
Tokens:1,662
Snippets:23
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install molabel

Source: https://koaning.github.io/molabel

Use the following command to install the library via uv.

```bash
uv pip install molabel
```

--------------------------------

### Initialize SimpleLabel Widget

Source: https://koaning.github.io/molabel

This snippet shows the basic initialization of the SimpleLabel widget. It requires a list of examples to annotate and a render function to display each example in the frontend. The examples can be any Python list, and the render function can use templating engines like Jinja2 or libraries like mohtml.

```python
from molabel import SimpleLabel

widget = SimpleLabel(examples=list_of_examples, render=render_function)
```

--------------------------------

### Configure SimpleLabel with Custom Rendering

Source: https://koaning.github.io/molabel

Example of initializing the widget with a custom render function using HTML elements.

```python
from molabel import SimpleLabel


def render(ex):
    return str(
        div(
            p("Is about a late delivery?", klass="text-2xl"),
            p(ex["text"], klass="text-gray-500"),
        )
    )


widget = mo.ui.anywidget(SimpleLabel(examples=[{"text": _} for _ in texts], render=render))

widget
```

--------------------------------

### Initialize SimpleLabel Widget

Source: https://koaning.github.io/molabel

Basic usage of the SimpleLabel widget requiring a list of examples and a render function.

```python
from molabel import SimpleLabel

widget = SimpleLabel(examples=list_of_examples, render=render_function)
widget
```

--------------------------------

### Define Custom Render Function for SimpleLabel

Source: https://koaning.github.io/molabel

This Python function defines how individual examples are rendered within the SimpleLabel widget. It uses `mohtml` components to create HTML structures, including paragraphs with custom CSS classes, to display the example text.

```python
from molabel import SimpleLabel

def render(ex):
  return str(
    div(
      p("Is about a late delivery?", klass="text-2xl"),
      p(ex["text"], klass="text-gray-500"),
    )
  )

widget = mo.ui.anywidget(SimpleLabel(examples=[{"text": _} for _ in texts], render=render))
widget
```

--------------------------------

### Import Marimo and HTML Components

Source: https://koaning.github.io/molabel

Imports necessary libraries including marimo, HTML components from mohtml, jinja2, and pandas for data manipulation.

```python
import marimo as mo
```

```python
from mohtml import p, tailwind_css, div, br, pre, code
from mohtml.components import terminal
import jinja2
import pandas as pd
```

--------------------------------

### Default Keyboard Shortcuts

Source: https://koaning.github.io/molabel

The default keyboard shortcut configuration for the annotation widget.

```python
default_shortcuts = {
    "Alt+1": "prev",
    "Alt+2": "yes", 
```

--------------------------------

### Default Gamepad Shortcuts for Molabel

Source: https://koaning.github.io/molabel

These are the default gamepad shortcuts for controlling Molabel annotations. Button mappings may vary depending on the gamepad.

```python
default_gamepad_shortcuts = {
"button_0": "yes", # Often A button
"button_1": "no", # Often B button 
"button_2": "skip", # Often X button
"button_3": "prev", # Often Y button
"button_4": "speech_notes", # Often left bumper
"button_6": "focus_notes" # Often left trigger
}
```

--------------------------------

### Load Data with Pandas

Source: https://koaning.github.io/molabel

Loads text data from a CSV file hosted on GitHub using pandas. This data is intended for use with Molabel.

```python
texts = list(
pd.read_csv(
"https://raw.githubusercontent.com/koaning/molabel/refs/heads/main/data/subset.csv"
)["text"]
)
```

--------------------------------

### Retrieve Annotations

Source: https://koaning.github.io/molabel

Access the collected annotations from the widget instance.

```python
widget.get_annotations()
```

--------------------------------

### Define Default Gamepad Shortcuts

Source: https://koaning.github.io/molabel

This dictionary defines default keyboard shortcuts for gamepad actions, mapping specific keys like 'Alt+3' to actions such as 'no' or 'skip'. It's useful for customizing user interaction with annotation tools.

```python
default_gamepad_shortcuts = {
    "Alt+3": "no",
    "Alt+4": "skip",
    "Alt+5": "focus_notes",
    "Alt+6": "speech_notes"
}
default_gamepad_shortcuts = {
    "button_0": "yes",  # Often A button
    "button_1": "no",   # Often B button  
    "button_2": "skip",  # Often X button
    "button_3": "prev",  # Often Y button
    "button_4": "speech_notes",  # Often left bumper
    "button_6": "focus_notes",  # Often left trigger
}
```

--------------------------------

### Load Data from CSV

Source: https://koaning.github.io/molabel

This Python code snippet loads text data from a CSV file hosted on GitHub using pandas. It reads the 'text' column from the specified CSV URL and returns it as a list.

```python
texts = list(
    pd.read_csv(
        "https://raw.githubusercontent.com/koaning/molabel/refs/heads/main/data/subset.csv"
    )[ "text" ]
)
return (texts,)
```

--------------------------------

### Default Keyboard Shortcuts for Molabel

Source: https://koaning.github.io/molabel

These are the default keyboard shortcuts for controlling Molabel annotations. They can be customized by passing keyword arguments during configuration.

```python
default_shortcuts = {
"Alt+1": "prev",
"Alt+2": "yes", 
"Alt+3": "no",
"Alt+4": "skip",
"Alt+5": "focus_notes",
"Alt+6": "speech_notes"
}
```
Tokens:
Raw