Skip to content

Commit 8dbf37e

Browse files
beautify-readmes
1 parent 101ed47 commit 8dbf37e

File tree

4 files changed

+47
-20
lines changed

4 files changed

+47
-20
lines changed

expression-measurement/batch/next-js-emotional-language/README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Next.js Emotional Language Example
2-
3-
| API | Models | Framework |
4-
| ------- | ---------- | -------------------- |
5-
| `batch` | `language` | Next.js (TypeScript) |
1+
<div align="center">
2+
<img src="https://storage.googleapis.com/hume-public-logos/hume/hume-banner.png">
3+
<h1>Expression Measurement | Next.js Emotional Language Example</h1>
4+
<p>
5+
<strong>Batch-analyze Language to Uncover Nuanced Human Expression.</strong>
6+
</p>
7+
</div>
68

79
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/fork/github/HumeAI/hume-api-examples/tree/main/typescript-next-api-language)
810

expression-measurement/batch/python-top-emotions/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<div align="center">
22
<img src="https://storage.googleapis.com/hume-public-logos/hume/hume-banner.png">
3-
<h1>Batch Expression Measurement | Sample Python Implementation</h1>
3+
<h1>Expression Measurement | Sample Python Implementation</h1>
44
<p>
5-
<strong>Jumpstart your development with Hume's Expression Measurement!</strong>
5+
<strong>Batch-analyze Facial Expressions using Hume's Python SDK.</strong>
66
</p>
77
</div>
88

Original file line numberDiff line numberDiff line change
@@ -1,29 +1,48 @@
1-
# Hume Raw Text Processor
1+
<div align="center">
2+
<img src="https://storage.googleapis.com/hume-public-logos/hume/hume-banner.png">
3+
<h1>Expression Measurement | TypeScript Raw Text Processor</h1>
4+
<p>
5+
<strong>Batch-analyze Text using Hume's TypeScript SDK.</strong>
6+
</p>
7+
</div>
28

3-
## Summary
9+
## Overview
410

511
This project serves as an example implementation of our Expression Measurement (REST) API processing raw text using our [Typescript SDK](https://www.npmjs.com/package/hume).
612

713
## Running Locally
814

9-
1. Clone the repo with `git clone origin https://github.com/HumeAI/hume-api-examples.git`
15+
1. Clone this examples repository:
1016

11-
2. Navigate to project directory `cd typescript-raw-text-processor`
17+
```shell
18+
git clone https://github.com/humeai/hume-api-examples
19+
cd hume-api-examples/expression-measurement/batch/typescript-raw-text-processor
20+
```
1221

13-
3. Install dependencies with `npm i`
22+
2. Install dependencies:
1423

15-
4. Setup environment variables
24+
```shell
25+
npm install
26+
```
1627

17-
a. Create `.env` file based off of `.env.example`
28+
3. Set up your API key:
1829

19-
b. Copy/paste your API key in from the [Portal](https://beta.hume.ai/settings/keys).
30+
You must authenticate to use the Hume Expression Measurement API. Your API key can be retrieved from the [Hume AI platform](https://platform.hume.ai/settings/keys). For detailed instructions, see our documentation on [getting your api keys](https://dev.hume.ai/docs/introduction/api-key).
2031

21-
5. Set configurations within the `src/index.ts` file.
32+
This example uses [dotenv](https://www.npmjs.com/package/dotenv). Place your API key in a `.env` file at the root of your project.
33+
34+
```shell
35+
echo "HUME_API_KEY='<YOUR API KEY>'" > .env
36+
```
37+
38+
You can copy the `.env.example` file to use as a template.
39+
40+
4. Set configurations within the `src/index.ts` file.
2241

2342
a. Specify which language.
2443

2544
b. Copy and paste the text to be processed.
2645

2746
c. Set Language Model configurations.
2847

29-
6. Run `npm run start` to process the specified text with the specified configurations and log predictions to the console.
48+
5. Run `npm run start` to process the specified text with the specified configurations and log predictions to the console.

expression-measurement/streaming/next-js-streaming-example/README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# Sandbox
2-
3-
## About
1+
<div align="center">
2+
<img src="https://storage.googleapis.com/hume-public-logos/hume/hume-banner.png">
3+
<h1>Expression Measurement | Next.js Streaming Example</h1>
4+
<p>
5+
<strong>Real-time Streaming of Facial, Vocal, and Language Expressions.</strong>
6+
</p>
7+
</div>
8+
9+
## Overview
410

511
This repo contains a NextJS app for demoing and testing Hume APIs. It implements several streaming interfaces that provide an intuitive validation of model quality.
612

0 commit comments

Comments
 (0)