Skip to content

Commit e54099d

Browse files
ChernovAndreyChernovAndrey
committed
added 3D validation and examples
1 parent 4c6bf0d commit e54099d

File tree

10 files changed

+269
-202
lines changed

10 files changed

+269
-202
lines changed

‎examples/basic-forecast.ts‎

Lines changed: 0 additions & 67 deletions
This file was deleted.

‎examples/basic_forecast/chronos2.ts‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,21 @@ async function main() {
55
if (!apiKey) throw new Error("FAIM_API_KEY required");
66

77
const client = new FaimClient(apiKey);
8-
const x: number[][][] = [[[1], [2], [3], [4], [5]]];
8+
const x: number[][][] = [[[1], [2], [3], [4], [5], [6], [7], [8], [9], [10]]];
99

1010
console.log("Chronos2 - Point Forecast");
1111
const result = await client.forecastChronos2({
1212
x,
13-
horizon: 10,
13+
horizon: 3,
1414
output_type: "point",
1515
});
16-
console.log(result.success ? "✓ Success" : `✗ ${result.error.error_code}: ${result.error.message}`);
16+
if (result.success) {
17+
console.log("✓ Success");
18+
console.log("Forecasted time series:");
19+
console.log(JSON.stringify(result.data.outputs.point, null, 2));
20+
} else {
21+
console.log(`✗ ${result.error.error_code}: ${result.error.message}`);
22+
}
1723
}
1824

1925
main().catch(console.error);

‎examples/basic_forecast/tirex.ts‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,21 @@ async function main() {
55
if (!apiKey) throw new Error("FAIM_API_KEY required");
66

77
const client = new FaimClient(apiKey);
8-
const x: number[][][] = [[[1], [2], [3], [4], [5]]];
8+
const x: number[][][] = [[[1], [2], [3], [4], [5], [6], [7], [8], [9], [10]]];
99

1010
console.log("TiRex - Point Forecast");
1111
const result = await client.forecastTiRex({
1212
x,
13-
horizon: 10,
13+
horizon: 3,
1414
output_type: "point",
1515
});
16-
console.log(result.success ? "✓ Success" : `✗ ${result.error.error_code}: ${result.error.message}`);
16+
if (result.success) {
17+
console.log("✓ Success");
18+
console.log("Forecasted time series:");
19+
console.log(JSON.stringify(result.data.outputs.point, null, 2));
20+
} else {
21+
console.log(`✗ ${result.error.error_code}: ${result.error.message}`);
22+
}
1723
}
1824

1925
main().catch(console.error);

‎examples/error-handling.ts‎

Lines changed: 0 additions & 76 deletions
This file was deleted.

‎examples/quantiles-forecast.ts‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎examples/quantiles_forecast/chronos2.ts‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,36 @@ async function main() {
55
if (!apiKey) throw new Error("FAIM_API_KEY required");
66

77
const client = new FaimClient(apiKey);
8-
const x: number[][][] = [[[1], [2], [3], [4], [5]]];
8+
const x: number[][][] = [[[1], [2], [3], [4], [5], [6], [7], [8], [9], [10]]];
99

1010
console.log("Chronos2 - Quantiles (default)");
1111
let result = await client.forecastChronos2({
1212
x,
13-
horizon: 10,
13+
horizon: 3,
1414
output_type: "quantiles",
1515
});
16-
console.log(result.success ? "✓ Success" : `✗ ${result.error.error_code}: ${result.error.message}`);
16+
if (result.success) {
17+
console.log("✓ Success");
18+
console.log("Forecasted quantiles:");
19+
console.log(JSON.stringify(result.data.outputs.quantiles, null, 2));
20+
} else {
21+
console.log(`✗ ${result.error.error_code}: ${result.error.message}`);
22+
}
1723

18-
console.log("\nChronos2 - Quantiles (custom: 0.1, 0.5, 0.9)");
24+
console.log("\n\nChronos2 - Quantiles (custom: 0.1, 0.5, 0.9)");
1925
result = await client.forecastChronos2({
2026
x,
21-
horizon: 10,
27+
horizon: 3,
2228
output_type: "quantiles",
2329
quantiles: [0.1, 0.5, 0.9],
2430
});
25-
console.log(result.success ? "✓ Success" : `✗ ${result.error.error_code}: ${result.error.message}`);
31+
if (result.success) {
32+
console.log("✓ Success");
33+
console.log("Forecasted quantiles:");
34+
console.log(JSON.stringify(result.data.outputs.quantiles, null, 2));
35+
} else {
36+
console.log(`✗ ${result.error.error_code}: ${result.error.message}`);
37+
}
2638
}
2739

2840
main().catch(console.error);

‎examples/quantiles_forecast/tirex.ts‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,21 @@ async function main() {
55
if (!apiKey) throw new Error("FAIM_API_KEY required");
66

77
const client = new FaimClient(apiKey);
8-
const x: number[][][] = [[[1], [2], [3], [4], [5]]];
8+
const x: number[][][] = [[[1], [2], [3], [4], [5], [6], [7], [8], [9], [10]]];
99

1010
console.log("TiRex - Quantiles (default)");
1111
const result = await client.forecastTiRex({
1212
x,
13-
horizon: 10,
13+
horizon: 3,
1414
output_type: "quantiles",
1515
});
16-
console.log(result.success ? "✓ Success" : `✗ ${result.error.error_code}: ${result.error.message}`);
16+
if (result.success) {
17+
console.log("✓ Success");
18+
console.log("Forecasted quantiles:");
19+
console.log(JSON.stringify(result.data.outputs.quantiles, null, 2));
20+
} else {
21+
console.log(`✗ ${result.error.error_code}: ${result.error.message}`);
22+
}
1723
}
1824

1925
main().catch(console.error);

‎src/client.ts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,43 @@ const DEFAULT_BASE_URL = "https://api.faim.it.com";
1313
const DEFAULT_TIMEOUT = 30000; // 30 seconds
1414
const DEFAULT_MAX_RETRIES = 2;
1515

16+
function validateInput3D(x: unknown): void {
17+
if (!Array.isArray(x)) {
18+
throw new Error(
19+
"Input x must be a 3D array with shape (batch_size, context_length, num_features). " +
20+
"Expected array but got " + typeof x
21+
);
22+
}
23+
24+
if (x.length === 0) {
25+
throw new Error(
26+
"Input x must be a 3D array with shape (batch_size, context_length, num_features). " +
27+
"Batch size cannot be empty."
28+
);
29+
}
30+
31+
if (!Array.isArray(x[0])) {
32+
throw new Error(
33+
"Input x must be a 3D array with shape (batch_size, context_length, num_features). " +
34+
"Example: For a single time-series [1, 2, 3, 4, 5], transform to [[[1], [2], [3], [4], [5]]]"
35+
);
36+
}
37+
38+
if (x[0].length === 0) {
39+
throw new Error(
40+
"Input x must be a 3D array with shape (batch_size, context_length, num_features). " +
41+
"Sequence length cannot be empty."
42+
);
43+
}
44+
45+
if (!Array.isArray(x[0][0])) {
46+
throw new Error(
47+
"Input x must be a 3D array with shape (batch_size, context_length, num_features). " +
48+
"Example: For a single time-series [1, 2, 3, 4, 5], transform to [[[1], [2], [3], [4], [5]]]"
49+
);
50+
}
51+
}
52+
1653
export class FaimClient {
1754
private httpClient: FetchClient;
1855
private timeout: number;
@@ -32,6 +69,8 @@ export class FaimClient {
3269
async forecastChronos2(
3370
request: Chronos2ForecastRequest,
3471
): Promise<Result<ForecastResponse>> {
72+
validateInput3D(request.x);
73+
3574
return withRetry(
3675
async () => {
3776
try {
@@ -61,6 +100,8 @@ export class FaimClient {
61100
}
62101

63102
async forecastTiRex(request: TiRexForecastRequest): Promise<Result<ForecastResponse>> {
103+
validateInput3D(request.x);
104+
64105
return withRetry(
65106
async () => {
66107
try {

0 commit comments

Comments
 (0)