echogarden 1.1.0 → 1.2.0

package/src/cli/CLIConfigFile.ts

@@ -56,10 +56,10 @@ export async function parseJSONConfigFile(path: string): Promise<ParsedConfigFil
 
 	const result: ParsedConfigFile = new Map()
 
-	for (const command in parsedJSON) {
-		const commandObj = parsedJSON[command]
+	for (const operation in parsedJSON) {
+		const operationObj = parsedJSON[operation]
 
-		const commandMap = new Map<string, string>()
+		const operationMap = new Map<string, string>()
 
 		function addFromObject(obj: any, pathPrefix: string): void {
 			for (const propertyName in obj) {
@@ -70,19 +70,19 @@ export async function parseJSONConfigFile(path: string): Promise<ParsedConfigFil
 
 				if (typeof propertyValue == 'object') {
 					if (Array.isArray(propertyValue)) {
-						commandMap.set(propertyPath, JSON.stringify(propertyValue))
+						operationMap.set(propertyPath, JSON.stringify(propertyValue))
 					} else {
 						addFromObject(propertyValue, propertyPath)
 					}
 				} else {
-					commandMap.set(propertyPath, propertyValue)
+					operationMap.set(propertyPath, propertyValue)
 				}
 			}
 		}
 
-		addFromObject(commandObj, '')
+		addFromObject(operationObj, '')
 
-		result.set(command, commandMap)
+		result.set(operation, operationMap)
 	}
 
 	return result

package/src/cli/CLIOptions.ts

@@ -0,0 +1,8 @@
+export interface CLIOptions {
+	play?: boolean
+	overwrite?: boolean
+	debug?: boolean
+	config?: string
+}
+
+export const CLIOptionsKeys: (keyof CLIOptions)[] = ['play', 'overwrite', 'debug', 'config']

package/src/cli/CLIParser.ts

@@ -1,8 +1,7 @@
-export function parseCLIArguments(command: string, args: string[]): CLIArguments {
-	const parsedArgs: CLIArguments = {
-		command,
-		commandArgs: [],
-		options: new Map(),
+export function parseCLIArguments(args: string[]): ParsedCLIArguments {
+	const parsedArgs: ParsedCLIArguments = {
+		operationArgs: [],
+		parsedArgumentsLookup: new Map(),
 	}
 
 	for (let i = 0; i < args.length; i++) {
@@ -16,26 +15,30 @@ export function parseCLIArguments(command: string, args: string[]): CLIArguments
 
 			const optionText = currentArg.substring(2)
 
-			const indexOfEquals = optionText.indexOf('=')
-			if (indexOfEquals == 0) {
+			const indexOfEqualSign = optionText.indexOf('=')
+			if (indexOfEqualSign == 0) {
 				throw new Error('An option cannot have an empty name.')
-			} else if (indexOfEquals == -1) {
-				parsedArgs.options.set(optionText, '')
+			} else if (indexOfEqualSign == -1) {
+				if (optionText.startsWith('no-')) {
+					parsedArgs.parsedArgumentsLookup.set(optionText.substring(3), 'false')
+				} else {
+					parsedArgs.parsedArgumentsLookup.set(optionText, '')
+				}
 			} else {
-				const key = optionText.substring(0, indexOfEquals)
-				const value = optionText.substring(indexOfEquals + 1)
-				parsedArgs.options.set(key, value)
+				const key = optionText.substring(0, indexOfEqualSign)
+				const value = optionText.substring(indexOfEqualSign + 1)
+
+				parsedArgs.parsedArgumentsLookup.set(key, value)
 			}
 		} else {
-			parsedArgs.commandArgs.push(currentArg)
+			parsedArgs.operationArgs.push(currentArg)
 		}
 	}
 
 	return parsedArgs
 }
 
-export type CLIArguments = {
-	command: string
-	commandArgs: string[]
-	options: Map<string, string>
+export interface ParsedCLIArguments {
+	operationArgs: string[]
+	parsedArgumentsLookup: Map<string, string>
 }

package/src/recognition/WhisperSTT.ts

@@ -442,7 +442,7 @@ export class Whisper {
 			partTokensConfidence = partTokensConfidence.slice(initialTokens.length)
 			partCrossAttentionQKs = partCrossAttentionQKs.slice(initialTokens.length)
 
-			// Compute compression ratio for part
+			// Compute compression ratio for part (disabled for now)
 			if (false) {
 				const compressionRatioForPart = (await getDeflateCompressionMetricsForString(this.tokensToText(partTokens))).ratio
 			}
@@ -453,9 +453,11 @@ export class Whisper {
 			// Generate timeline from alignment path
 			const partTimeline = await this.getTokenTimelineFromAlignmentPath(alignmentPath, partTokens, segmentStartTime, segmentEndTime, partTokensConfidence)
 
+			// Add tokens to output
 			allDecodedTokens.push(...partTokens)
 			timeline.push(...partTimeline)
 
+			// Update previous text tokens
 			previousPartTextTokens = partTokens.filter(token => this.isTextToken(token))
 
 			audioOffset = audioEndOffset
@@ -479,22 +481,24 @@ export class Whisper {
 
 		whisperAlignmentOptions = extendDeep(defaultWhisperAlignmentOptions, whisperAlignmentOptions)
 
+		const targetLanguage = task === 'transcribe' ? sourceLanguage : 'en'
+
 		const shouldSplitToSentences = false
 
 		let simplifiedTranscript = ''
 
 		if (shouldSplitToSentences) {
-			const sentences = splitToSentences(transcript, 'en')
+			const sentences = splitToSentences(transcript, targetLanguage)
 
 			for (const sentence of sentences) {
-				let sentenceWords = await splitToWords(sentence, 'en')
+				let sentenceWords = await splitToWords(sentence, targetLanguage)
 				sentenceWords = sentenceWords.filter(word => isWord(word))
 
 				simplifiedTranscript += sentenceWords.join(' ')
 				simplifiedTranscript += ' '
 			}
 		} else {
-			let words = await splitToWords(transcript, 'en')
+			let words = await splitToWords(transcript, targetLanguage)
 			words = words.map(word => word.trim())
 			words = words.filter(word => isWord(word))
 			simplifiedTranscript = words.join(' ')
@@ -712,7 +716,8 @@ export class Whisper {
 
 		// Start decoding loop
 		for (let decodedTokenCount = 0; decodedTokenCount < options.maxTokensPerPart!; decodedTokenCount++) {
-			const isInitialState = decodedTokens.length == initialTokens.length
+			const isInitialState = decodedTokens.length === initialTokens.length
+			const atLeastOneTextTokenDecoded = decodedTokens.slice(initialTokens.length).some(token => this.isTextToken(token))
 
 			// If not in initial state, reshape KV Cache tensor to accomodate a new output token
 			if (!isInitialState) {
@@ -744,10 +749,10 @@ export class Whisper {
 				offset: offsetTensor
 			}
 
-			// Run decoder
+			// Run decoder model
 			const decoderOutputs = await this.textDecoder!.run(decoderInputs)
 
-			// Store results
+			// Extract decoder model results
 			const logitsBuffer = decoderOutputs['logits'].data as Float32Array
 			kvCacheTensor = decoderOutputs['output_kv_cache'] as any
 
@@ -764,7 +769,7 @@ export class Whisper {
 				allTokenLogits[suppressedTokenIndex] = -Infinity
 			}
 
-			if (isInitialState) {
+			if (!atLeastOneTextTokenDecoded) {
 				// If in initial state, suppress end-of-text token
 				allTokenLogits[endOfTextToken] = -Infinity
 			}
@@ -779,13 +784,19 @@ export class Whisper {
 					return false
 				}
 
+				if (isInitialState) {
+					addToken(timestampTokensStart, timestampTokenLogits, 1.0, crossAttentionQKsForToken)
+
+					return true
+				}
+
 				const previousTokenWasTimestamp = this.isTimestampToken(decodedTokens[decodedTokens.length - 1])
 				const secondPreviousTokenWasTimestamp = this.isTimestampToken(decodedTokens[decodedTokens.length - 2])
 
 				// If there are two successive timestamp tokens decoded, or the previous timestamp was the first token,
 				// don't decode a timestamp
 				if (previousTokenWasTimestamp &&
-					(decodedTokens.length === initialTokens.length + 1) || secondPreviousTokenWasTimestamp) {
+					((decodedTokens.length === initialTokens.length + 1) || secondPreviousTokenWasTimestamp)) {
 					return false
 				}
 
@@ -817,6 +828,7 @@ export class Whisper {
 				timestampTokenSeenCount += 1
 
 				if (previousTokenWasTimestamp) {
+					// If previously decoded token was a timestamp token, repeat it
 					const previousToken = decodedTokens[decodedTokens.length - 1]
 					const previousTokenTimestampLogits = decodedTokensTimestampLogits[decodedTokensTimestampLogits.length - 1]
 					const previousTokenConfidence = decodedTokensConfidence[decodedTokensConfidence.length - 1]
@@ -825,6 +837,7 @@ export class Whisper {
 
 					lastTimestampTokenIndex = decodedTokens.length
 				} else {
+					// Otherwise decode the highest probability timestamp
 					const timestampToken = timestampTokensStart + indexOfMaxTimestampLogProb
 					const confidence = probabilities[timestampToken]
 
@@ -834,6 +847,7 @@ export class Whisper {
 				return true
 			}
 
+			// Call the method to decode timestamp token if needed
 			const timestampTokenDecoded = decodeTimestampTokenIfNeeded()
 
 			if (timestampTokenDecoded) {
@@ -847,9 +861,9 @@ export class Whisper {
 
 			let shouldDecodeEndfOfTextToken = false
 
-			// If not in initial state, and the end-of-text token's probability is sufficiently higher than
-			// the second highest ranked token, then set to accept it
-			if (!isInitialState) {
+			// If at least one text token was decoded, and the end-of-text token's probability is
+			// sufficiently higher than the second highest ranked token, then accept end-of-text
+			if (atLeastOneTextTokenDecoded) {
 				const endOfTextTokenLogit = nonTimestampTokenLogits[endOfTextToken]
 
 				const otherTokensLogits = nonTimestampTokenLogits.slice()
@@ -888,7 +902,7 @@ export class Whisper {
 					nonTimestampTokenLogits[suppressedTokenIndex] = -Infinity
 				}
 
-				// Suppress space token if at initial state
+				// Suppress the space token if at initial state
 				if (isInitialState) {
 					nonTimestampTokenLogits[spaceToken] = -Infinity
 				}
@@ -902,7 +916,7 @@ export class Whisper {
 				break
 			}
 
-			// Suppress end-of-text if it shouldn't be included in candidates
+			// Suppress end-of-text token if it shouldn't be included in candidates
 			if (!options.includeEndTokenInCandidates) {
 				nonTimestampTokenLogits[endOfTextToken] = -Infinity
 			}
@@ -924,8 +938,8 @@ export class Whisper {
 			if (options.suppressRepetition) {
 				// Using some hardcoded constants, for now
 				const tokenWindowSize = 30
-				const thresholdMatchLength = 6
-				const thresholdCycleRepetition = 2.0
+				const thresholdMatchLength = 4
+				const thresholdCycleRepetition = 3
 
 				const filteredCandidates: typeof topCandidates = []
 
@@ -1072,8 +1086,10 @@ export class Whisper {
 			throw new Error(`Audio part is longer than 30 seconds`)
 		}
 
+		// Compute a mel spectogram
 		await logger.startAsync('Extract mel spectogram from audio part')
 
+		// Pad audio samples to ensure that have a duration of 30 seconds
 		const paddedAudioSamples = new Float32Array(maxAudioSamples)
 		paddedAudioSamples.set(audioSamples, 0)
 
@@ -1084,6 +1100,8 @@ export class Whisper {
 		await logger.startAsync('Normalize mel spectogram')
 
 		const logMelSpectogram = melSpectogram.map(spectrum => spectrum.map(mel => Math.log10(Math.max(mel, 1e-10))))
+
+		// Find maximum log mel value in the spectrum
 		let maxLogMel = -Infinity
 
 		for (const spectrum of logMelSpectogram) {
@@ -1094,9 +1112,11 @@ export class Whisper {
 			}
 		}
 
+		// Normalize log mel spectogram (based on Python reference code)
 		const normalizedLogMelSpectogram = logMelSpectogram.map(spectrum => spectrum.map(
 			logMel => (Math.max(logMel, maxLogMel - 8) + 4) / 4))
 
+		// Flatten the normalized log mel spectogram
 		const flattenedNormalizedLogMelSpectogram = new Float32Array(maxAudioFrames * filterbankCount)
 
 		for (let i = 0; i < filterbankCount; i++) {
@@ -1105,6 +1125,7 @@ export class Whisper {
 			}
 		}
 
+		// Run the encoder model
 		await logger.startAsync('Encode mel spectogram with Whisper encoder model')
 
 		const inputTensor = new Onnx.Tensor('float32', flattenedNormalizedLogMelSpectogram, [1, filterbankCount, maxAudioFrames])
@@ -1758,7 +1779,7 @@ export function normalizeWhisperModelName(modelName: WhisperModelName, languageC
 		modelName = modelName.slice(0, modelName.length - 3) as WhisperModelName
 
 		const logger = new Logger()
-		logger.logTitledMessage(`Warning`, `The model '${originalModelName}' is English only and cannot be used to transcribe language '${languageCode}'. using '${modelName}' instead.`, chalk.yellowBright)
+		logger.logTitledMessage(`Warning`, `The model '${originalModelName}' is English only and cannot be used to transcribe language '${languageCode}'. Using '${modelName}' instead.`, chalk.yellowBright, 'warning')
 	}
 
 	return modelName

package/src/utilities/FileDownloader.ts

@@ -9,6 +9,7 @@ import path from 'node:path'
 import { extractTarball } from './Compression.js'
 import { createWriteStream, move, remove, readdir, ensureDir } from './FileSystem.js'
 import chalk from 'chalk'
+import { logLevelGreaterOrEqualTo } from '../api/GlobalOptions.js'
 
 export async function downloadAndExtractTarball(options: GaxiosOptions, targetDir: string, baseTempPath: string, displayName = 'archive') {
 	const logger = new Logger()
@@ -18,7 +19,10 @@ export async function downloadAndExtractTarball(options: GaxiosOptions, targetDi
 	const tempDirPath = path.join(baseTempPath, `/${randomID}`)
 	await ensureDir(tempDirPath)
 
+	logger.end()
+
 	await downloadFile(options, tempTarballPath, `${chalk.cyanBright('Downloading')} ${chalk.greenBright(displayName)}`)
+
 	logger.end()
 
 	logger.start(`Extracting ${displayName}`)
@@ -40,7 +44,7 @@ export async function downloadAndExtractTarball(options: GaxiosOptions, targetDi
 }
 
 export async function downloadFile(options: GaxiosOptions, targetFilePath: string, prompt = 'Downloading') {
-	const write = writeToStderr
+	const write = logLevelGreaterOrEqualTo('info') ? writeToStderr : () => {}
 
 	const downloadPromise = new OpenPromise<void>()
 

package/src/utilities/Logger.ts

@@ -1,6 +1,7 @@
 import chalk from 'chalk'
 import { Timer } from './Timer.js'
 import { logToStderr, writeToStderr, yieldToEventLoop } from './Utilities.js'
+import { LogLevel, logLevelGreaterOrEqualTo, logLevelSmallerThan } from '../api/GlobalOptions.js'
 
 let currentActiveLogger: Logger | null = null
 
@@ -23,7 +24,9 @@ export class Logger {
 			await yieldToEventLoop()
 		}
 
-		writeToStderr(`${titleColor(title)}.. `)
+		if (logLevelGreaterOrEqualTo('info')) {
+			writeToStderr(`${titleColor(title)}.. `)
+		}
 
 		this.setAsActiveLogger()
 
@@ -44,30 +47,41 @@ export class Logger {
 		if (this.active && currentActiveLogger == this) {
 			const elapsedTime = this.timer.elapsedTime
 
-			writeToStderr(`${elapsedTime.toFixed(1)}ms\n`)
+			if (logLevelGreaterOrEqualTo('info')) {
+				writeToStderr(`${elapsedTime.toFixed(1)}ms\n`)
+			}
+
 			currentActiveLogger = null
 		}
 
 		this.active = false
 	}
 
-	logDuration(message: any, startTime: number, titleColor = chalk.cyanBright) {
+	logDuration(message: any, startTime: number, titleColor = chalk.cyanBright, logLevel: LogLevel = 'info') {
 		const duration = Timer.currentTime - startTime
 
-		this.log(`${titleColor(message)}: ${duration.toFixed(1)}ms`)
+		this.log(`${titleColor(message)}: ${duration.toFixed(1)}ms`, logLevel)
 	}
 
-	logTitledMessage(title: string, content: string, titleColor = chalk.cyanBright) {
-		this.log(`${titleColor(title)}: ${content}`)
+	logTitledMessage(title: string, content: any, titleColor = chalk.cyanBright, logLevel: LogLevel = 'info') {
+		this.log(`${titleColor(title)}: ${content}`, logLevel)
 	}
 
-	log(message: any) {
+	log(message: any, logLevel: LogLevel = 'info') {
+		if (logLevelSmallerThan(logLevel)) {
+			return
+		}
+
 		if (currentActiveLogger == this || currentActiveLogger == null) {
 			logToStderr(message)
 		}
 	}
 
-	write(message: any) {
+	write(message: any, logLevel: LogLevel = 'info') {
+		if (logLevelSmallerThan(logLevel)) {
+			return
+		}
+
 		if (currentActiveLogger == this || currentActiveLogger == null) {
 			writeToStderr(message)
 		}

package/src/utilities/PackageManager.ts

@@ -4,6 +4,7 @@ import { getAppDataDir, ensureDir, existsSync, remove } from './FileSystem.js'
 import { appName } from '../api/Common.js'
 import { GaxiosOptions } from 'gaxios'
 import { getAppTempDir } from './PathUtilities.js'
+import { getGlobalOption } from '../api/GlobalOptions.js'
 
 export async function loadPackage(packageName: string) {
 	packageName = resolveToVersionedPackageNameIfNeeded(packageName)
@@ -16,13 +17,15 @@ export async function loadPackage(packageName: string) {
 		return packagePath
 	}
 
+	const packageBaseURL = getGlobalOption('packageBaseURL')
+
 	const tempPath = getAppTempDir(appName)
 
 	const headers = {
 	}
 
 	const options: GaxiosOptions = {
-		url: `${basePackageUrl}${packageName}.tar.gz`,
+		url: `${packageBaseURL}${packageName}.tar.gz`,
 		headers
 	}
 
@@ -76,8 +79,6 @@ export function resolveVersionTagForUnversionedPackageName(unversionedPackageNam
 	return packageVersionTagResolutionLookup[unversionedPackageName] || defaultVersionTag
 }
 
-const basePackageUrl = 'https://huggingface.co/echogarden/echogarden-packages/resolve/main/'
-
 const defaultVersionTag = '20230718'
 
 const packageVersionTagResolutionLookup: { [packageName: string]: string } = {

package/src/utilities/Utilities.ts

@@ -517,7 +517,7 @@ export function getTokenRepetitionScore(tokens: string[] | number[]) {
 			longestMatch = matchLength
 		}
 
-		const cycleCount = matchLength / i
+		const cycleCount = (matchLength / i) + 1
 
 		if (cycleCount > longestCycleRepetition) {
 			longestCycleRepetition = cycleCount
@@ -540,7 +540,7 @@ export async function resolveModuleScriptPath(moduleName: string) {
 export async function runOperationWithRetries<R>(
 	operationFunc: () => Promise<R>,
 	logger: Logger,
-	opreationName = 'Operation',
+	operationName = 'Operation',
 	delayBetweenRetries = 2000,
 	maxRetries = 200) {
 
@@ -560,21 +560,21 @@ export async function runOperationWithRetries<R>(
 
 			logger.setAsActiveLogger()
 
-			logger.logTitledMessage(`Error`, e.message, chalk.redBright)
-			logger.log(``)
-			logger.logTitledMessage(`${opreationName} failed`, `Trying again in ${delayBetweenRetries}ms..`, chalk.redBright)
+			logger.logTitledMessage(`Error`, e.message, chalk.redBright, 'error')
+			logger.log('', 'error')
+			logger.logTitledMessage(`${operationName} failed`, `Trying again in ${delayBetweenRetries}ms..`, chalk.redBright, 'error')
 
 			await delay(delayBetweenRetries)
 
-			logger.log(``)
-			logger.logTitledMessage(`Starting retry attempt`, `${retryIndex} / ${maxRetries}`, chalk.yellowBright)
-			logger.log(``)
+			logger.log(``, 'warning')
+			logger.logTitledMessage(`Starting retry attempt`, `${retryIndex} / ${maxRetries}`, chalk.yellowBright, 'warning')
+			logger.log(``, 'warning')
 
 			logger.unsetAsActiveLogger()
 		}
 	}
 
-	throw new Error(`${opreationName} failed after ${maxRetries} retry attempts`)
+	throw new Error(`${operationName} failed after ${maxRetries} retry attempts`)
 }
 
 export function writeToStdinInChunks(process: ChildProcessWithoutNullStreams, buffer: Buffer, chunkSize: number) {