writeWordEmbedding — Write a word embedding model to a UTF-8 word2vec text file.
writeWordEmbedding(emb, filename) writes a RunMat wordEmbedding compatibility object to a UTF-8 text file in word2vec text format.
Syntax
writeWordEmbedding(emb, filename)Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
emb | Any | Yes | — | wordEmbedding object. |
filename | Any | Yes | — | Target UTF-8 word2vec text file. |
Errors
| Identifier | When | Message |
|---|---|---|
RunMat:writeWordEmbedding:InvalidInput | Inputs do not match the supported writeWordEmbedding form. | writeWordEmbedding received invalid input |
RunMat:writeWordEmbedding:IOError | The requested word embedding file cannot be written. | Unable to write word embedding file |
How writeWordEmbedding works
embmust be awordEmbeddingcompatibility object withDimension,Vocabulary, and vector storage created byreadWordEmbedding,trainWordEmbedding, orfastTextWordEmbedding.filenamemay be a string scalar, character vector, or a 1-by-1 cell array containing a character vector.- The output file starts with a
numWords dimensionheader followed by one row per vocabulary word and its vector values. - The target file is created or overwritten. Parent directories must already exist.
- Vocabulary entries containing whitespace and non-finite vector values are rejected because word2vec text rows cannot represent them unambiguously.
- Binary word2vec output, zip output, append mode, and format-selection options are not part of MATLAB's documented
writeWordEmbeddingsyntax and are not accepted.
GPU memory and residency
writeWordEmbedding is a file-I/O sink. Any GPU-resident filename input is gathered before serialization; wordEmbedding objects are host metadata objects, and no provider kernels are launched.
Examples
Write a trained embedding
documents = tokenizedDocument(["red blue red"; "green blue"]);
emb = trainWordEmbedding(documents, 'Dimension', 8, 'MinCount', 1);
writeWordEmbedding(emb, "colors.vec")Expected output:
`colors.vec` contains UTF-8 word2vec text embedding data.Round-trip an embedding file
writeWordEmbedding(emb, "model.vec");
copy = readWordEmbedding("model.vec");
copy.DimensionExpected output:
`copy` is a `wordEmbedding` compatibility object with the same vocabulary and vectors.Using writeWordEmbedding with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how writeWordEmbedding changes the result.
Run a small writeWordEmbedding example, explain the result, then change one input and compare the output.
FAQ
What file format does writeWordEmbedding use?⌄
It writes UTF-8 word2vec text format with a header row and one word-vector row per vocabulary entry.
Does writeWordEmbedding create folders?⌄
No. Create the parent folder first with mkdir if needed.
Does writeWordEmbedding execute on the GPU?⌄
No. It is host object serialization and file I/O.
Related Strings functions
Text Analytics
addDependencyDetails · addEntityDetails · addLemmaDetails · addPartOfSpeechDetails · addSentenceDetails · addTypeDetails · bagOfNgrams · bagOfWords · cosineSimilarity · doc2sequence · encode · extractFileText · extractHTMLText · fastTextWordEmbedding · findElement · getAttribute · htmlTree · ind2word · isVocabularyWord · normalizeWords · readWordEmbedding · removeLongWords · removeShortWords · removeStopWords · removeWords · stopWords · tokenDetails · tokenizedDocument · trainWordEmbedding · vaderSentimentScores · vec2word · word2ind · word2vec · wordEncoding
Transform
append · deblank · erase · eraseBetween · erasePunctuation · eraseURLs · extractAfter · extractBefore · extractBetween · insertAfter · insertBefore · join · lower · pad · replace · replaceBetween · reverse · split · splitlines · strcat · strip · strjoin · strjust · strrep · strsplit · strtrim · upper
Core
blanks · char · compose · convertCharsToStrings · convertContainedStringsToChars · convertStringsToChars · genvarname · int2str · isletter · isspace · isStringScalar · isstrprop · mat2str · native2unicode · newline · num2str · sprintf · sscanf · str2double · str2num · strcmp · strcmpi · string · string.empty · strings · strlength · strncmp · strncmpi · strtok · unicode2native
Search
contains · endsWith · matches · startsWith · strfind
Pattern
digitsPattern · lettersPattern · pattern · regexpPattern · textBoundary · wildcardPattern
Open-source implementation
Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how writeWordEmbedding is executed, line by line, in Rust.
- View the source for writeWordEmbedding in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.