Update README.md
Browse files
README.md
CHANGED
|
@@ -39,17 +39,47 @@ Crucially, it is highly effective at isolating environmental topics from **broad
|
|
| 39 |
>π‘ Designed for: Precision text classification in sustainable finance, ESG analysis, and corporate governance contexts.
|
| 40 |
|
| 41 |
---
|
|
|
|
| 42 |
|
| 43 |
-
##
|
| 44 |
|
| 45 |
-
|
|
|
|
|
|
|
|
|
|
| 46 |
|
| 47 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 48 |
|
| 49 |
-
|
| 50 |
|
| 51 |
-
|
| 52 |
|
|
|
|
| 53 |
```
|
| 54 |
"A(An) {sponsor_type}-type sponsor has filed a shareholder proposal to a(an)
|
| 55 |
{sic2_des}-sector company. This proposal requests: {resolution}.
|
|
@@ -57,6 +87,16 @@ It falls under a broader agenda class that may include items not directly
|
|
| 57 |
relevant to this specific proposal: {AgendaCodeInformation}"
|
| 58 |
```
|
| 59 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 60 |
|
| 61 |
## π¦ Training Data
|
| 62 |
|
|
|
|
| 39 |
>π‘ Designed for: Precision text classification in sustainable finance, ESG analysis, and corporate governance contexts.
|
| 40 |
|
| 41 |
---
|
| 42 |
+
## π Usage
|
| 43 |
|
| 44 |
+
### β‘ Quick Start
|
| 45 |
|
| 46 |
+
Install dependencies first:
|
| 47 |
+
```bash
|
| 48 |
+
pip install transformers torch
|
| 49 |
+
```
|
| 50 |
|
| 51 |
+
Then run the following:
|
| 52 |
+
```python
|
| 53 |
+
from transformers import pipeline
|
| 54 |
+
|
| 55 |
+
# 1. Load the model
|
| 56 |
+
classifier = pipeline(
|
| 57 |
+
"text-classification",
|
| 58 |
+
model="Jidi1997/ClimateBERT_GPROP_Detector"
|
| 59 |
+
)
|
| 60 |
+
|
| 61 |
+
# 2. Construct a proposal input
|
| 62 |
+
test_proposal = """
|
| 63 |
+
A(An) institutional-type sponsor has filed a shareholder proposal to a(an)
|
| 64 |
+
energy-sector company. This proposal requests: the company to issue a report
|
| 65 |
+
on its greenhouse gas emissions reduction targets.
|
| 66 |
+
It falls under a broader agenda class that may include items not directly
|
| 67 |
+
relevant to this specific proposal: Environmental/Social.
|
| 68 |
+
"""
|
| 69 |
+
|
| 70 |
+
# 3. Run inference
|
| 71 |
+
result = classifier(test_proposal)
|
| 72 |
+
print(result)
|
| 73 |
+
# Expected output: [{'label': 'yes', 'score': 0.99...}]
|
| 74 |
+
# label='yes' β Green proposal detected (Label 1)
|
| 75 |
+
# label='no' β Non-green proposal (Label 0)
|
| 76 |
+
```
|
| 77 |
|
| 78 |
+
---
|
| 79 |
|
| 80 |
+
### π Recommended Input Format
|
| 81 |
|
| 82 |
+
To achieve optimal performance, structure your input text to mirror the training data format:
|
| 83 |
```
|
| 84 |
"A(An) {sponsor_type}-type sponsor has filed a shareholder proposal to a(an)
|
| 85 |
{sic2_des}-sector company. This proposal requests: {resolution}.
|
|
|
|
| 87 |
relevant to this specific proposal: {AgendaCodeInformation}"
|
| 88 |
```
|
| 89 |
|
| 90 |
+
| Field | Description | Example |
|
| 91 |
+
|:---|:---|:---|
|
| 92 |
+
| `{sponsor_type}` | Type of proposal sponsor | `institutional`, `individual` |
|
| 93 |
+
| `{sic2_des}` | SIC-2 industry sector description | `energy`, `manufacturing` |
|
| 94 |
+
| `{resolution}` | Full text of the proposal resolution | *"the company to report on..."* |
|
| 95 |
+
| `{AgendaCodeInformation}` | ISS agenda code label *(optional but recommended)* | `Environmental/Social` |
|
| 96 |
+
|
| 97 |
+
> π‘ **Tip:** The `{AgendaCodeInformation}` field is optional but including it generally improves prediction confidence, as it provides additional categorical context into brief resolution context.
|
| 98 |
+
|
| 99 |
+
|
| 100 |
|
| 101 |
## π¦ Training Data
|
| 102 |
|