Skip to content

Commit 92cd651

Browse files
Update README.md to include Parakeet paper
1 parent 02e4793 commit 92cd651

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ Bharathan Balaji, Venkata Sai Gargeya Vunnava, Geoffrey Guest, Jared Kramer
99
[Flamingo: Environmental Impact Factor Matching for Life Cycle Assessment with Zero-Shot Machine Learning](https://www.amazon.science/publications/flamingo-environmental-impact-factor-matching-for-life-cycle-assessment-with-zero-shot-machine-learning)
1010
Bharathan Balaji, Venkata Sai Gargeya Vunnava, Shikhar Gupta, Nina Domingo, Harsh Gupta, Geoffrey Guest, Aravind Srinivasan
1111

12+
3. EIF matching with generative AI, published in [CCAI@NeurIPS 2024](https://www.climatechange.ai/) -- \
13+
[Parakeet: Emission Factor Recommendation for Carbon Footprinting with Generative AI](https://www.amazon.science/publications/parakeet-emission-factor-recommendation-for-carbon-footprinting-with-generative-ai) \
14+
Bharathan Balaji, Fahimeh Ebrahimi, Nina Domingo, Gargeya Vunnava, Abu-Zaher Faridee, Soma Ramalingam, Shikhar Gupta, Anran Wang, Harsh Gupta, Domenic Belcastro, Kellen Axten, Jeremie Hakian, Jared Kramer
15+
1216
## Installation
1317
Required packages are given in `requirements.txt`
1418
Run the following commands to install the package:
@@ -24,6 +28,34 @@ Follow the code in `notebooks` folder.\
2428
For EIO-LCA use: `notebooks/eio/demo.ipynb`\
2529
for process LCA use: `notebooks/process/generate_ranked_preds.ipynb`
2630

31+
## Parakeet
32+
For running the code, you must have an AWS account to call bedrock.
33+
34+
Create a `User` in your AWS account with your own key `id` and `key` following these steps
35+
```
36+
AWS Console -> IAM -> Users -> Create user -> provide user name -> attach policies directly ->
37+
AmazonSageMakerFullAccess
38+
AmazonS3FullAccess
39+
AmazonBedrockFullAccess
40+
-> Create user
41+
AWS Console -> IAM -> Users -> [username] -> Access key 1/create access key -> Local code -> Set description (eifmap) -> copy the "Access Key" and "Secret Access Key"
42+
```
43+
44+
Add these entries in `~/.aws/credentials` file.
45+
46+
```
47+
[AWS_Account_Name]
48+
aws_access_key_id=XXX
49+
aws_secret_access_key=YYY
50+
51+
```
52+
Demo scripts are in the `scripts` folder. Be sure to modify the `OUTPUT_FILE` variable in order to avoid overwritting your results.
53+
```
54+
cd parakeet/scripts
55+
./generate_ranked_preds_eio.sh # for EEIO
56+
./generate_ranked_preds_pLCA.sh # for pLCA
57+
```
58+
2759
## Dataset
2860
The dataset is for research purposes only, and is not indicative of Amazon’s business use for carbon footprinting.
2961

@@ -60,4 +92,14 @@ Below is the BibTeX text, if you would like to cite our work.
6092
url = {https://www.amazon.science/publications/flamingo-environmental-impact-factor-matching-for-life-cycle-assessment-with-zero-shot-machine-learning}
6193
booktitle = {ACM Journal on Computing and Sustainable Societies},
6294
}
63-
```
95+
```
96+
97+
```
98+
@Inproceedings{Balaji2024,
99+
author = {Bharathan Balaji and Fahimeh Ebrahimi and Nina Domingo and Gargeya Vunnava and Abu-Zaher Faridee and Soma Ramalingam and Shikhar Gupta and Anran Wang and Harsh Gupta and Domenic Belcastro and Kellen Axten and Jeremie Hakian and Jared Kramer},
100+
title = {Parakeet: Emission factor recommendation for carbon footprinting with generative AI},
101+
year = {2024},
102+
url = {https://www.amazon.science/publications/parakeet-emission-factor-recommendation-for-carbon-footprinting-with-generative-ai},
103+
booktitle = {NeurIPS 2024 Workshop on Tackling Climate Change with Machine Learning},
104+
}
105+
```

0 commit comments

Comments
 (0)