Skip to content

Commit db7f294

Browse files
address Robbie's readme comments
1 parent fcd23c4 commit db7f294

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

README.md

+23-20
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,35 @@ It can be used with OpenAI LLMs accessible through an API:
88
and local LLMs:
99
![Local LLM Attribution Table](docs/assets/local-PIZZA.png)
1010

11-
And
1211
## Index
13-
- [Quickstart](#quickstart)
14-
- [Requirements](#requirements)
15-
- [Packaging](#packaging)
16-
- [Linting](#linting)
17-
- [Installation](#installation)
18-
- [API Design](#api-design)
19-
- [BaseLLMAttributor](#basellmattributor)
20-
- [LocalLLMAttributor](#localllmattributor)
21-
- [OpenAIAttributor](#OpenAIAttributor)
22-
- [PerturbationStrategy and AttributionStrategy](#perturbationstrategy-and-attributionstrategy)
23-
- [ExperimentLogger](#experimentlogger)
24-
- [Limitations](#limitations)
25-
- [Batch dimensions](#batch-dimensions)
26-
- [Input Embeddings](#input-embeddings)
27-
- [GPU Acceleration](#gpu-acceleration)
28-
- [Development](#development)
29-
- [Testing](#testing)
12+
- [LLM Attribution Library](#llm-attribution-library)
13+
- [Index](#index)
14+
- [Quickstart](#quickstart)
15+
- [Requirements](#requirements)
16+
- [Packaging](#packaging)
17+
- [Linting](#linting)
18+
- [Installation](#installation)
19+
- [API Design](#api-design)
20+
- [BaseLLMAttributor](#basellmattributor)
21+
- [LocalLLMAttributor](#localllmattributor)
22+
- [Cleaning Up](#cleaning-up)
23+
- [OpenAIAttributor](#openaiattributor)
24+
- [PerturbationStrategy and AttributionStrategy](#perturbationstrategy-and-attributionstrategy)
25+
- [ExperimentLogger](#experimentlogger)
26+
- [Limitations](#limitations)
27+
- [Batch dimensions](#batch-dimensions)
28+
- [Input Embeddings](#input-embeddings)
29+
- [GPU Acceleration](#gpu-acceleration)
30+
- [Development](#development)
31+
- [Testing](#testing)
32+
- [Research](#research)
3033

3134
## Quickstart
3235

3336

3437
Attrubution via OpenAI's API:
3538

36-
# !!! This will use API credits !!!
39+
**!!! This will use API credits !!!**
3740

3841
```python
3942
from attribution.api_attribution import OpenAIAttributor
@@ -83,7 +86,7 @@ attributor.print_attributions(
8386
)
8487
```
8588

86-
Usage examples can be found in the `examples/` folder. There's also a colab-hosted quickstart notebook [here](https://colab.research.google.com/drive/1yf6izSzZg2K88QyaJwAwkZPPyLP4pPa-?usp=sharing).
89+
Usage examples can be found in the `examples/` folder.
8790

8891
## Requirements
8992

0 commit comments

Comments
 (0)