Skip to content

Commit

Permalink
Fix typos (ShishirPatil#323)
Browse files Browse the repository at this point in the history
Fix some README.md typos
  • Loading branch information
viniciuslazzari authored Apr 6, 2024
1 parent 37a8373 commit c622106
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ In the immediate future, we plan to release the following:
- [ ] BFCL metrics to evaluate contamination
- [ ] BFCL systems metrics including cost and latency
- [ ] BFCL update with "live" data and user-votes
- [ ] Openfunctions-v3 model to support more languges and multi-turn capability
- [ ] Openfunctions-v3 model to support more languages and multi-turn capability
- [x] Berkeley Function Calling leaderboard (BFCL) for evaluating tool-calling/function-calling models [Feb 26, 2024]
- [x] Openfunctions-v2 with more languages (Java, JS, Python), relevance detection [Feb 26, 2024]
- [x] API Zoo Index for easy access to all APIs [Feb 16, 2024]
Expand Down
4 changes: 2 additions & 2 deletions berkeley-function-call-leaderboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ To run the executable test categories, there are 4 API keys to fill out:
* Covid 19: https://rapidapi.com/api-sports/api/covid-193
* Time zone by Location: https://rapidapi.com/BertoldVdb/api/timezone-by-location

All the Rapid APIs we use have free tier usage. As a result, you need to subscribe to those API providers in order to have the executable test enviornment setup but it will be free of charge!
All the Rapid APIs we use have free tier usage. As a result, you need to subscribe to those API providers in order to have the executable test environment setup but it will be free of charge!

2. Exchange Rate API:https://www.exchangerate-api.com
3. OMDB API: http://www.omdbapi.com/apikey.aspx
4. Geocode API: https://geocode.maps.co/

The `apply_function_credential_config.py` inputs an input file, optionally an outputs file. If the output file is not given as an argument, it will overwrites your original file with the claned data.
The `apply_function_credential_config.py` inputs an input file, optionally an outputs file. If the output file is not given as an argument, it will overwrites your original file with the cleaned data.

```bash
python apply_function_credential_config.py --input_file ./data/gorilla_openfunctions_v1_test_rest.json
Expand Down
2 changes: 1 addition & 1 deletion berkeley-function-call-leaderboard/data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ language:

The Berkeley function calling leaderboard is a live leaderboard to evaluate the ability of different LLMs to call functions (also referred to as tools).
We built this dataset from our learnings to be representative of most users' function calling use-cases, for example, in agents, as a part of enterprise workflows, etc.
To this end, our evaluation dataset spans diverse categories, and across multiple languges.
To this end, our evaluation dataset spans diverse categories, and across multiple languages.

Checkout the Leaderboard at [gorilla.cs.berkeley.edu/leaderboard.html](https://gorilla.cs.berkeley.edu/leaderboard.html)
and our [release blog](https://gorilla.cs.berkeley.edu/blogs/8_berkeley_function_leaderboard.html)!
Expand Down
6 changes: 3 additions & 3 deletions data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ Community members can submit to Gorilla API Zoo using the following JSON list fo
| :--- | :----: | :---- | :---: |
| user_name | String | Name of User ||
| api_name | String | Name of API (maximum 20 words) ||
| api_call | String | One line of code that starts with the function call, fullowed by a full list of argument names and values ||
| api_call | String | One line of code that starts with the function call, followed by a full list of argument names and values ||
| api_version | String | Version of API ||
| api_arguments | JSON | JSON of all the restricted keywords in the arguments list ||
| functionality | String | Short description of the function (maximum 20 words) ||
| env_requirements | List[String] | List of all the library dependencies | [Optional]:fire: |
| example_code | String | A string containing example code to use the API | [Optional]:fire: |
| meta_data | JSON | A JSON file of containing additional information about the API | [Optional]:fire: |
| Questions | List[String] | A question describing a real-life scenario that uses this API. Please donnot include specific API name. | [Optional]:fire: |
| Questions | List[String] | A question describing a real-life scenario that uses this API. Please do not include specific API name. | [Optional]:fire: |

**Example Submission**:

Expand Down Expand Up @@ -85,7 +85,7 @@ Community members can submit to Gorilla API Zoo using the following JSON list fo

### Option 2: URL JSON

We also provide you with a much simpler approach for you to contribute! Provide a simple url to your API documentation, we'll process it for you. Keep in mind, there might be some errors that can creep in with this process and hence we recommend the approach above, or atleast come back to verify if the api documentation we generated for these url's are accurate! They API document generated from the urls will be stored as mentined in the directory structure above.
We also provide you with a much simpler approach for you to contribute! Provide a simple url to your API documentation, we'll process it for you. Keep in mind, there might be some errors that can creep in with this process and hence we recommend the approach above, or at least come back to verify if the api documentation we generated for these url's are accurate! They API document generated from the urls will be stored as mentioned in the directory structure above.

Submit a json file containing the list of json objects:

Expand Down
4 changes: 2 additions & 2 deletions inference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can either run Gorilla through our hosted [![Colab](https://colab.research.g

New: We release `gorilla-mpt-7b-hf-v0` and `gorilla-falcon-7b-hf-v0` - two Apache 2.0 licensed models (commercially usable).

`gorilla-7b-hf-v0` is the first set of weights we released :tada: It chooses from 925 HF APIs in a 0-shot fashion (without any retrieval). Update: We released `gorilla-7b-th-v0` with 94 (exhaustive) APIs from Torch Hub and `gorilla-7b-tf-v0` with 626 (exhaustive) APIs from Tensorflow. In spirit of openess, we do not filter, nor carry out any post processing either to the prompt nor response :gift: Keep in mind that the current `gorilla-7b-*` models do not have any geenric chat capability. We do have a model with all the 1600+ APIs which also has chat capability, which we release slowly to accommodate server demand.
`gorilla-7b-hf-v0` is the first set of weights we released :tada: It chooses from 925 HF APIs in a 0-shot fashion (without any retrieval). Update: We released `gorilla-7b-th-v0` with 94 (exhaustive) APIs from Torch Hub and `gorilla-7b-tf-v0` with 626 (exhaustive) APIs from Tensorflow. In spirit of openness, we do not filter, nor carry out any post processing either to the prompt nor response :gift: Keep in mind that the current `gorilla-7b-*` models do not have any generic chat capability. We do have a model with all the 1600+ APIs which also has chat capability, which we release slowly to accommodate server demand.

All gorilla weights hosted at [https://huggingface.co/gorilla-llm/](https://huggingface.co/gorilla-llm/).

Expand Down Expand Up @@ -90,7 +90,7 @@ this [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https:
Running local inference with Gorilla on a clean interface is simple. Follow the instructions below to set up [text-generation-webui](https://github.com/oobabooga/text-generation-webui), add your desired models, and run inference.


My specs, M1 Macbook Air 2020
My specs, M1 MacBook Air 2020
```
Model Name: MacBook Air
Model Identifier: MacBookAir10,1
Expand Down
4 changes: 2 additions & 2 deletions openfunctions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

## Introduction
Gorilla OpenFunctions extends Large Language Model(LLM) Chat Completion feature to formulate
executable APIs call given natural language instructions and API context. With OpenFunctions v2 7B paramter model,
executable APIs call given natural language instructions and API context. With OpenFunctions v2 7B parameter model,
we now support:
1. Multiple functions - choose betwen functions
1. Multiple functions - choose between functions
2. Parallel functions - call the same function `N` time with different parameter values
3. Multiple & parallel - both of the above in a single chatcompletion call (one generation)
4. Relevance detection - when chatting, chat. When asked for function, returns a function
Expand Down
10 changes: 5 additions & 5 deletions raft/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## RAFT

RAFT is a recipie to adapting LLMs to domain-specific RAG. You can learn more in our release-blogs [here](https://gorilla.cs.berkeley.edu/blogs/9_raft.html) and [here](https://techcommunity.microsoft.com/t5/ai-ai-platform-blog/bg-p/AIPlatformBlog). RAFT takes an input document from the user and creates a dataset using the document, consisting of synthetically generated `{ question, answer, documents }` triplets. The dataset can then be used to fine-tune models for improved question-answering and retrieval.
RAFT is a recipe to adapting LLMs to domain-specific RAG. You can learn more in our release-blogs [here](https://gorilla.cs.berkeley.edu/blogs/9_raft.html) and [here](https://techcommunity.microsoft.com/t5/ai-ai-platform-blog/bg-p/AIPlatformBlog). RAFT takes an input document from the user and creates a dataset using the document, consisting of synthetically generated `{ question, answer, documents }` triplets. The dataset can then be used to fine-tune models for improved question-answering and retrieval.

The input data from the user can be either a general text document (pdf, json, or txt) for general QA or an API documentation in the API Zoo JSONL format for API calling.

Expand Down Expand Up @@ -48,7 +48,7 @@ python3 raft.py --datapath sample_data/United_States_PDF.pdf --output ./sample_d
#### 1. Chunk generation
RAFT takes pdf and divides text into chunks of size 512 tokens. A sample chunk:
```python
"[CLS] United States of America Flag Coat of arms Motto : \" In God We Trust \" [ 1 ] Other traditional mottos : [ 2 ] \" E pluribus unum \" ( Latin ) \" Out of many, one \" \" Annuit cœptis \" ( Latin ) \" Providence favors our undertakings \" \" Novus ordo seclorum \" ( Latin ) \" New order of the ages \" Anthem : \" The Star - Spangled Banner \" [ 3 ] United States The United States of America ( USA or U. S. A. ), commonly know n as the United States ( US or U. S. ) or America, is a country primarily located in North America, between Canada and Mexico. It is a liberal democracy and republic of 50 federated states, a federal capital district ( Washington, D. C. ), and 326 Indian reservations that overlap with state bounda ries. Outside the union of states, it asserts sovereignty over five major unincorporated island territories and various uninhabited islands. [ i ] The country has the world\'s third - largest land area, [ c ] largest maritime exclusive econom ic zone, and the third - largest popul ation ( over 334 million ). [ j ] The federal gove rnment uses a presidential system with three separate branches : legislative, executive, and judicial. American territory was first settled by Paleo - Indians who migrated across the Bering land bridge over 12, 000 years ago. Colonization by the British began in 1607. Thirteen colonies eventually rebelled against the British Crown over taxation and political representation, declaring independence on July 4, 1776. Their victory in the American Revolutionary War ( 1775 – 83 ) resulted in a confederation of states before the U. S. Constitution and Bill of Rights were ratified. The young nation continued to acquire neighbor ing territories and spanned North America by the late 1840s. Longstanding disagreements over slavery led to the secession of the southern Confederate States of America, which were defeated by the remaining Union in the American Civil War ( 1861 – 65 ). Slavery was abolished, but discriminatory laws persisted in the South. By 1900, rapid indus trialization established the United States as a great power and the world\'s largest economy. Following the Japanese attack on Pearl Harbor in December 1941, the United States joined the Allies of World War II. After their victory, it competed against the Soviet Union for dominance in nuclear and conve ntional"
"[CLS] United States of America Flag Coat of arms Motto : \" In God We Trust \" [ 1 ] Other traditional mottos : [ 2 ] \" E pluribus unum \" ( Latin ) \" Out of many, one \" \" Annuit cœptis \" ( Latin ) \" Providence favors our undertakings \" \" Novus ordo seclorum \" ( Latin ) \" New order of the ages \" Anthem : \" The Star - Spangled Banner \" [ 3 ] United States The United States of America ( USA or U. S. A. ), commonly know n as the United States ( US or U. S. ) or America, is a country primarily located in North America, between Canada and Mexico. It is a liberal democracy and republic of 50 federated states, a federal capital district ( Washington, D. C. ), and 326 Indian reservations that overlap with state boundaries. Outside the union of states, it asserts sovereignty over five major unincorporated island territories and various uninhabited islands. [ i ] The country has the world\'s third - largest land area, [ c ] largest maritime exclusive economic zone, and the third - largest population ( over 334 million ). [ j ] The federal government uses a presidential system with three separate branches : legislative, executive, and judicial. American territory was first settled by Paleo - Indians who migrated across the Bering land bridge over 12, 000 years ago. Colonization by the British began in 1607. Thirteen colonies eventually rebelled against the British Crown over taxation and political representation, declaring independence on July 4, 1776. Their victory in the American Revolutionary War ( 1775 – 83 ) resulted in a confederation of states before the U. S. Constitution and Bill of Rights were ratified. The young nation continued to acquire neighbor ing territories and spanned North America by the late 1840s. Longstanding disagreements over slavery led to the secession of the southern Confederate States of America, which were defeated by the remaining Union in the American Civil War ( 1861 – 65 ). Slavery was abolished, but discriminatory laws persisted in the South. By 1900, rapid industrialization established the United States as a great power and the world\'s largest economy. Following the Japanese attack on Pearl Harbor in December 1941, the United States joined the Allies of World War II. After their victory, it competed against the Soviet Union for dominance in nuclear and conventional"
```

#### 2. Question and answer generation
Expand Down Expand Up @@ -84,9 +84,9 @@ For each question-answer pair, append 4 randomly selected chunks as distractor d
'sentences': [
["the Gulf of Mexico are prone to hurricanes, ... and enforces the Act. [ 189 ] As of 2022, the U. S",
"energy from fossil fuel and the largest ... there are 19, 969 airports in the U. S., of which 5, 193 are designated",
'weaponry, ideology, and international i... and is a permanent member of the UN Security Counc il. The first documentary evidence of the phrase " United States',
'[CLS] United States of America Flag Coat of arms ... dominance in nuclear and conve ntional',
'##om ic soft pow er. [ 405 ] [ 406 ] Nearly all present ... rights in the United States are advanced by gl obal standards.']
'weaponry, ideology, and international i... and is a permanent member of the UN Security Council. The first documentary evidence of the phrase " United States',
'[CLS] United States of America Flag Coat of arms ... dominance in nuclear and conventional',
'##om ic soft pow er. [ 405 ] [ 406 ] Nearly all present ... rights in the United States are advanced by global standards.']
],
'title': [
['placeholder_title',
Expand Down

0 comments on commit c622106

Please sign in to comment.