Asked by Michael
on 5 Jul 2013

I have a matlab file that contains one variable, a 64000x31250 array of singles. I use matfile to pull single columns out of that array. I've done similar operations on smaller (say 7000x31250) arrays and had it work fine. However, with this matrix, each column read takes 20!!!! seconds. In the profiler, essentially all of the time is taken on matfile.m's line 460:

[varargout{1:nargout}] = internal.matlab.language.partialLoad(obj.Properties.Source, varSubset, '-mat');

all this work (saving, matfile'ing, etc.) is done in 2012B and in 7.3 file format.

To set the performance scale, reading in the entire variable with a load command takes 127 seconds (ie less than the time matfile is taking to read 7 of the 31250 columns).

edit: a few details I should have included: 24 gigs ram, windows 7 x64, CPU is i7-950 (4 cores, 8 with hyperthreading), disk activity is very, very low during this process, but a single core is running at max speed (ie, one matlab process is using 13% CPU on the "8 core" CPU throughout.

Any ideas why matfile is choking so badly?

Answer by per isakson
on 6 Jul 2013

Edited by per isakson
on 25 Jul 2013

Accepted Answer

Summary: "column-major" does not apply to the matlab.io.MatFile class when it comes to reading speed.

---

Column-major or row-major?

Doc on hdf5read says:

[...]HDF5 describes data set dimensions in row-major order; MATLAB stores

data in column-major order. However, permuting these dimensions may not

correctly reflect the intent of the data and may invalidate metadata. When

BOOL is false (the default), the data dimensions correctly reflect the data

ordering as it is written in the file — each dimension in the output variable

matches the same dimension in the file.

Matlab uses column-major order and HDF5 uses row-major order. The MAT-file 7.3 file format "is" HDF5.

The following test ( R2012a 64bit, 8GB, Windows 7) shows that for a .<5000x5000 single>:

- reading one column takes approximately half the time compared to reading the full matrix
- reading one row is approx 20 times faster than reading one column.

In this case the matrix is so small that my 8GB should not be a bottleneck.

N = 5e3;

filespec = 'matfile_test.mat';

mat = rand( N, 'single' );

save( filespec, 'mat', '-v7.3' )

obj = matfile( filespec );

tic, mfm = obj.mat; toc

tic, h5m = h5read( filespec, '/mat' ); toc

dfm = mfm-mat;

d5m = h5m-mat;

max(abs(dfm(:)))

max(abs(d5m(:)))

tic, mfm = obj.mat( :, 1 ); toc

tic, h5m = h5read( filespec, '/mat', [1,1], [N,1] ); toc

dfm = mfm-mat( :, 1 );

d5m = h5m-mat( :, 1 );

max(abs(dfm(:)))

max(abs(d5m(:)))

tic, mfm = obj.mat( 1, : ); toc

tic, h5m = h5read( filespec, '/mat', [1,1], [1,N] ); toc

dfm = mfm-mat( 1, : );

d5m = h5m-mat( 1, : );

max(abs(dfm(:)))

max(abs(d5m(:)))

returns

Elapsed time is 1.955082 seconds.

Elapsed time is 1.674106 seconds.

ans =

0

ans =

0

Elapsed time is 0.984833 seconds.

Elapsed time is 0.822843 seconds.

ans =

0

ans =

0

Elapsed time is 0.056097 seconds.

Elapsed time is 0.029657 seconds.

ans =

0

ans =

0

>>

.

2013-07-24: Test with R2013a 64bit, 8GB, Windows 7; same computer, same OS, and new Matlab release. The results below are from the third run of the script after restarting the computer and Matlab. There is a little improvement in speed. However, nothing comparable with the result of reading a row, which Matt J report in the comment.

>> matfile_h5_script

Elapsed time is 2.626919 seconds.

Elapsed time is 1.219851 seconds.

ans =

0

ans =

0

Elapsed time is 0.809362 seconds.

Elapsed time is 0.765147 seconds.

ans =

0

ans =

0

Elapsed time is 0.049908 seconds.

Elapsed time is 0.020192 seconds.

ans =

0

ans =

0

>>

per isakson
on 23 Jul 2013

Matt J
on 24 Jul 2013

Windows 7 Pro (64-bit), R2012a. I have a pretty fast SSD, too. Don't know if that's a contributor.

per isakson
on 24 Jul 2013

I assume that you obtained the numbers after running the script a few times in a row. That is, the data are available in the system cache.

The SSD should make a large difference when running the script for the first time after restarting Windows. (I know of no other way to "clear" the system cache.)

There is a difference between our result, which I cannot explain. I have to leave it with that.

Sign in to comment.

Answer by Isaac Asimov
on 25 Jan 2018

Fortunately I have finally found a practical solution to this problem, that is:

----------------------------------------------------------

Put your varible in cells and then save it to a MAT-file.

Do not save it directly as a double array/matrix!

----------------------------------------------------------

I have tested this method in my computer, and the result is amazing:

tic;

m1 = matfile('var_as_matrix.mat.mat');

x1 = m1.trs_sample(1,:);

toc;

% Elapsed time is 8.686759 seconds.

tic;

m2 = matfile('var_as_cell.mat.mat');

x2 = m2.trs_sample(1,:);

y2 = x2{:};

toc;

% Elapsed time is 0.295925 seconds!

Let me do some explanations.

I have a large data set (not sparse) and I read it as a matrix. Its size is 1000x250000 (int8).

When I save the matrix directly as a MAT-File ('-v7.3'):

- MATLAB automatically change the data type to `double`. (You can check this by yourself. Use matfile('YourMatFilePath'), the console will show you its properties. )
- Its size is about 400 MB.
- It takes about 8.7 s to assign the first row of the matrix to a variable.

When I put each row into a cell and then save it (with the same settings):

- I get a 1000x1 cell, and the data type keeps `int8`.
- Its size is about 200 MB. The size is reduced by half!
- It takes about 0.3 s to fetch the first cell and then assign its contents to a variable. It is almost 30x faster than the upper! (I have tested this for another several times, and the speed keeps between 15x and 30x faster.)

----------------------------------------------------------

But why this method works?

I guess that, when you reconstruct the matrix to cells, the saved MAT-file is "better structured", because you build a higher hierarchy above the original matrix.

Thus, when you read the "better structured" MAT-file from the disk, MATLAB can parse and read the data more efficently. And I think that is why the method improves the performance remarkably.

----------------------------------------------------------

I hope my method can help you more or less.

Currently, apart from my solution, I have not found any other useful suggestion to this problem. This is strange, because the problem is so common and critical. And even four years after the question was asked, there is no feasible solution.

If anyone knows some more details, please share with us and post your answer here. It would be a great help to people who might encounter the similar problem.

Isaac Asimov
on 26 Jan 2018

@Peter Cook

The same with you, I also thought that MATLAB would not reassign everything to double, but when I checked the type of the directly saved MAT-file, I found that the type was changed. While putting the matrix into cells, the type would not change. Seeing is believing.

-----------------------------------------

I agree with your opinions on the indexing issue, since MATLAB has documented this on the tips of function matfile:

Using the end keyword as part of an index causes MATLAB to load the entire variable into memory. For very large variables, this load operation results in Out of Memory errors. Rather than using end, determine the extent of a variable, myVar, with the size method ...

But the key point of this problem may not be indexing. Even indexing a small part of a large directly saved matrix could take much time. If you do not believe, you can test this and show your code and result.

And I think that the key point is the structure of saved variables.

Peter Cook
on 27 Jan 2018

This conversation got me curious, so I did a few benchmarks on my machine.

clear,clc,close all

d=dir('phaseVariance.mat');

fprintf('File Size: %d bytes\n',d.bytes);

matObj = matfile('phaseVariance.mat');

[mRow,nCol] = size(matObj,'phaseVariance');

%lets load a subset of the data 4 different ways and compare elapsed time

try

t1 = tic;

A = matObj.phaseVariance(:,1000001:9999999);

dt1 = toc(t1);

clearvars A

fprintf('A = matObj.phaseVariance(:,1000001:9999999);\n %0.1f s\n',dt1);

catch MERR

fprintf('A = matObj.phaseVariance(:,1000001:9999999);\n');

disp(MERR.identifier)

disp(MERR.message)

end

try

t2 = tic;

A = matObj.phaseVariance(1:end,1000001:9999999);

dt2 = toc(t2);

clearvars A

fprintf('A = matObj.phaseVariance(1:end,1000001:9999999);\n %0.1f s\n',dt2);

catch MERR

fprintf('A = matObj.phaseVariance(1:end,1000001:9999999);\n');

disp(MERR.identifier)

disp(MERR.message)

end

try

t3 = tic;

A = matObj.phaseVariance(1:mRow,1000001:9999999);

dt3 = toc(t3);

clearvars A

fprintf('A = matObj.phaseVariance(1:mRow,1000001:9999999);\n %0.1f s\n',dt3);

catch MERR

fprintf('A = matObj.phaseVariance(1:mRow,1000001:9999999);\n');

disp(MERR.identifier)

disp(MERR.message)

end

try

t4 = tic;

load('phaseVariance.mat'); A = phaseVariance(:,1000001:9999999);

dt4 = toc(t4);

clearvars A

fprintf('load(''phaseVariance.mat''); A = phaseVariance(:,1000001:9999999);\n %0.1f s\n',dt4);

catch MERR

fprintf('load(''phaseVariance.mat''); A = phaseVariance(:,1000001:9999999);\n');

disp(MERR.identifier)

disp(MERR.message)

end

File Size: 11181693932 bytes

Method 1:

A = matObj.phaseVariance(:,1000001:9999999);

54.8 s

Method 2:

A = matObj.phaseVariance(1:end,1000001:9999999);

MATLAB:array:SizeLimitExceeded

Requested 1134x25307520 (26.7GB) array exceeds maximum array size preference. Creation of arrays greater than this limit may take a long time and cause MATLAB to become unresponsive. See array size limit or preference panel for more information.

Method 3:

A = matObj.phaseVariance(1:mRow,1000001:9999999);

54.9 s

Method 4:

load('phaseVariance.mat'); A = phaseVariance(:,1000001:9999999);

MATLAB:array:SizeLimitExceeded

Requested 1134x25307520 (26.7GB) array exceeds maximum array size preference. Creation of arrays greater than this limit may take a long time and cause MATLAB to become unresponsive. See array size limit or preference panel for more information.

Did MATLAB convert my array to double precision?

>> class(A)

ans =

uint8

>> mRow

mRow =

1134

>> nCol

nCol =

25307520

>> sprintf('%0.0f Bytes',mRow*nCol)

ans =

28698727680 Bytes

>> d=dir('phaseVariance.mat');

>> sprintf('Size on Disk %0.0f Bytes',d.bytes)

ans =

Size on Disk 11181693932 Bytes

If I am using 8 bits per array element, I would need 28,698,727,680 bytes in memory; through some HDF5 witchcraft it only occupies 11,181,693,932 bytes on disk. Based on the size in RAM/disk it doesn't look like its been converted to a double precision number at any step on either RAM or disk, but let's double check. Since a v7.3 MAT file is actually an HDF5 file, I can use the python h5py library to open and check it:

import h5py

fptr = h5py.File('phaseVariance.mat','r')

fptr.items()

Out[3]:

[(u'phaseVariance',

<HDF5 dataset "phaseVariance": shape (25307520, 1134), type "|u1">)]

u1 is python-ese for a 1 byte unsigned integer, so it's not be stored on disk as a double.

But since I've already got iPython open, lets see how fast it reads that slice of my MAT file compared to MATLAB.

%timeit fptr['phaseVariance'][1000000:9999998,range(1134)]

1 loop, best of 3: 56.1 s per loop

%timeit fptr['phaseVariance'][1000000:9999998,:]

1 loop, best of 3: 1min 19s per loop

#maybe a python range object will be more efficient than a list for the larger index?

%timeit fptr['phaseVariance'][range(1000000,9999999),0:1133]

1 loop, best of 3: 1min 58s per loop

Seems the best I can load that array chunk in either MATLAB or python is about 56 seconds.

Isaac Asimov
on 30 Jan 2018

@Peter Cook

Excellent tests and results! It's amazing that you tested so large data in so many ways. And the python codes are also illuminating. Your patience and carefulness impress me!

------------------------------------

On the issue of type conversion, you are absolutely right. I made a mistake before:

I did not notice that my data were read by fread() before saved, and what fread() returns are double values.

I ignored this and did not contain this part in my previous codes. By comparing your codes and mine, I finally found that this was the cause. My opinion was wrong.

Here is the test:

fid = fopen('test_chars.txt');

tmp = fread(fid,1,'uint8');

class(tmp)

I get:

ans =

'double'

The type 'uint8' I specify in the fread() function only affects how MATLAB parses the data, not how it returns.

------------------------------------

Here is a more interesting question I mentioned before:

Have you ever tried to put each row of the matrix into a cell and then read only one row?

This time I will expain with codes.

Firstly, create a big matrix consisting of random numbers:

randMatrix = rand(100,500000);

Secondly, put each row of the matrix into a cell:

randCell = cell(100,1);

for i = 1:size(randMatrix,1)

randCell{i} = randMatrix(i,:);

end

randCell

We get a [100 x 1] cell arary and each cell is a [1 x 500000] double.

randCell =

100×1 cell array

[1×500000 double]

[1×500000 double]

[1×500000 double]

...

Thirdly, save the two variables into MAT-files:

save('randMatrix.mat','randMatrix','-v7.3');

save('randCell.mat','randCell','-v7.3');

Then read the first row of each file and compare the time cost:

First file (saving matrix directly):

tic;

mfMatrix = matfile('randMatrix.mat');

tmp1 = mfMatrix.randMatrix(1,:);

class(tmp1)

size(tmp1)

toc;

And it take a lot of time:

ans =

'double'

ans =

1 500000

Elapsed time is 2.930694 seconds.

Second file (saved as a cell array):

tic;

mfCell = matfile('randCell.mat');

tmp = mfCell.randCell(1,1); % Get the first cell containing a row vector

tmp2 = tmp{1,:}; % Assign to a row vector

class(tmp2)

size(tmp2)

toc;

And it takes much less time:

ans =

'double'

ans =

1 500000

Elapsed time is 0.055028 seconds.

The absolute time cost may change among different tests, but the performance differences are always huge.

OK, let's check whether what we get in two ways are the same:

isequal(tmp1,tmp2)

Of course yes:

ans =

logical

1

That is what I really want to say about:

Saving a matrix as a cell array can be read faster than saving it directly.

I did not expain my idea well on my previous post.

I am glad to hear your opinions on this result, and also hope that you could point out something that I might ignore.

Sign in to comment.

Answer by per isakson
on 5 Jul 2013

Edited by per isakson
on 6 Jul 2013

I'm neither surprised nor chocked.

Which OS, and how much RAM installed?

Your matrix is large

>> 64000*31250*4/1e9

ans =

8

that is 8GB.

7.3 file format "is" HDF5.

A little experiment to show that RAM is important. (R2012a 64bit, 8GB, Windows 7)

N = 1e4;

filespec = 'matfile_test.mat';

mat = rand( N, 'single' );

save( filespec, 'mat', '-v7.3' )

tic,

h5m = h5read( filespec, '/mat', [1,1], [N,1] ); toc

tic,

obj = matfile( filespec );

mfm = obj.mat( :, 1 );

toc

d5m = h5m-mat( :, 1 );

dfm = mfm-mat( :, 1 );

max(abs(d5m(:)))

max(abs(dfm(:)))

returns

Elapsed time is 3.214658 seconds.

Elapsed time is 3.499495 seconds.

ans =

0

ans =

0

Create a variable just to use RAM

>> buf = zeros( N );

and rerun the script, which now returns

Elapsed time is 52.967529 seconds.

Elapsed time is 52.730371 seconds.

ans =

0

ans =

0

Watch the Windows Task Manager|Performance during the reading.

Answer by Jason Climer
on 11 Apr 2018

Edited by per isakson
on 11 Apr 2018

Sign in to comment.

Opportunities for recent engineering grads.

Apply Today
## 4 Comments

## Matt J (view profile)

Direct link to this comment:https://de.mathworks.com/matlabcentral/answers/81232-matfile-runs-incredibly-slowly-on-large-files-what-might-be-the-problem#comment_158495

## Michael (view profile)

Direct link to this comment:https://de.mathworks.com/matlabcentral/answers/81232-matfile-runs-incredibly-slowly-on-large-files-what-might-be-the-problem#comment_158499

## per isakson (view profile)

Direct link to this comment:https://de.mathworks.com/matlabcentral/answers/81232-matfile-runs-incredibly-slowly-on-large-files-what-might-be-the-problem#comment_161428

## Isaac Asimov (view profile)

Direct link to this comment:https://de.mathworks.com/matlabcentral/answers/81232-matfile-runs-incredibly-slowly-on-large-files-what-might-be-the-problem#comment_528314

Sign in to comment.