Skip to content

[SN-0] Updated model chat evaluation to correct name #1649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions examples/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Contribution Guide
# Contribution guide

Thank you for contributing to our notebook examples! To ensure that your contribution aligns with our guidelines, please carefully review the following guide.

## Table of Contents
## Table of contents

- [General Notebook Requirements](#general-notebook-requirements)
- [Branches and Tags](#branches-and-tags)
- [Github Workflows](#github-workflows)
- [General Prerequisites](#general-prerequisites)
- [Styling Tools](#styling-tools)
- [General notebook requirements](#general-notebook-requirements)
- [Branches and tags](#branches-and-tags)
- [Github workflows](#github-workflows)
- [General prerequisites](#general-prerequisites)
- [Styling tools](#styling-tools)

## General Notebook Requirements
## General notebook requirements

Review our [template notebook](template.ipynbs) for general overview on how notebooks should be structure. The template notebook and this section just serves as a guide and exceptions can be made. Here are our general requirements:

Expand All @@ -27,23 +27,23 @@ Review our [template notebook](template.ipynbs) for general overview on how note
> [!IMPORTANT]
> Please make sure to remove any API keys before pushing changes

## Branches and Tags
## Branches and tags

- All development happens in feature branches ideally prefixed by contributor's initials. For example `fs/feature_name`.
- Approved PRs are merged to the `develop` branch.
- All releases align to a git tag.

## Github Workflows
## Github workflows

- Github Branch Workflow
- When you push to a branch that contains files inside the examples directory, it will automatically reformat your notebook to match our given style and provide appropriate headers. Once this workflow is completed it will commit back to your branch which then you can pull.
- If your push contains new notebooks or modifies the names of notebooks the readme will be updated to reflect the change with updated links.

## General Prerequisites
## General prerequisites

[Rye](https://rye-up.com/) may be installed before contributing to the repository as it is the tool used to style our example notebooks. This could be used to avoid the github styling workflow. This is also the packaging tool used for the main SDK. The pyproject used for the example notebooks is a virtual package and does not get published.

## Styling Tools
## Styling tools

Rye is setup in this directory to use a customs script that will run the notebooks through our formatting tools and create readmes.

Expand Down
11 changes: 3 additions & 8 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,6 @@
</tr>
</thead>
<tbody>
<tr>
<td>Export V1 to V2 Migration Support</td>
<td><a href="https://github.com/Labelbox/labelbox-python/tree/develop/examples/exports/export_v1_to_v2_migration_support.ipynb" target="_blank"><img src="https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white" alt="Open In Github"></a></td>
<td><a href="https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/exports/export_v1_to_v2_migration_support.ipynb" target="_blank"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"></a></td>
</tr>
<tr>
<td>Composite Mask Export</td>
<td><a href="https://github.com/Labelbox/labelbox-python/tree/develop/examples/exports/composite_mask_export.ipynb" target="_blank"><img src="https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white" alt="Open In Github"></a></td>
Expand All @@ -105,9 +100,9 @@
</thead>
<tbody>
<tr>
<td>Model Chat Evaluation Project</td>
<td><a href="https://github.com/Labelbox/labelbox-python/tree/develop/examples/project_configuration/model_chat_evaluation_project.ipynb" target="_blank"><img src="https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white" alt="Open In Github"></a></td>
<td><a href="https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/model_chat_evaluation_project.ipynb" target="_blank"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"></a></td>
<td>Live Multimodal Chat Project</td>
<td><a href="https://github.com/Labelbox/labelbox-python/tree/develop/examples/project_configuration/live_multimodal_chat_project.ipynb" target="_blank"><img src="https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white" alt="Open In Github"></a></td>
<td><a href="https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/live_multimodal_chat_project.ipynb" target="_blank"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"></a></td>
</tr>
<tr>
<td>Project Setup</td>
Expand Down
Loading