Skip to content
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
3 changes: 3 additions & 0 deletions MANIFEST.IN
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
recursive-include src/evaluation_instruments/instruments *
exclude tests/*
prune tests
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,23 @@ This package is not currently published to PyPI, so it must be installed from so

### Installation

Clone this repository into a directory accessible to your Python environment, then run:
This package is not currently published to PyPI, but it can be installed directly from GitHub using `pip`. This is the recommended approach for programmatic use (e.g., from scripts or services):

```bash
pip install git+https://github.com/epic-open-source/evaluation-instruments.git@vX.Y.Z
```

**Note:** It is recommended to pin to a specific release tag (e.g., @v0.0.2) to ensure reproducibility and avoid unexpected changes from future updates.

This installs the package along with evaluation instruments — rubrics, prompts, and supporting logic — used to assess AI-generated outputs in specific clinical contexts. Instruments are included for completeness but are not required for all workflows or runtime use.

Alternatively, you can clone the repository into a directory accessible to your Python environment,

```bash
git clone https://github.com/epic-open-source/evaluation-instruments.git
```

and then run:

```bash
pip install .
Expand Down
1 change: 1 addition & 0 deletions changelog/9.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Adding a ``MANIFEST.in`` to ensure the entire ``instruments/`` folder is included in pip-installed distributions.
5 changes: 4 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = evaluation-instruments
version = 0.0.1
version = 0.0.2
description = evaluation-instruments: Evaluation instruments for healthcare AI use cases
author = Epic
author_email = OpenSourceContributions-Python@epic.com
Expand Down Expand Up @@ -32,6 +32,9 @@ include =
evaluation_instruments
evaluation_instruments.*

[options.package_data]
evaluation_instruments = instruments/**/*

[options.extras_require]
all =
dev =
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.