Analysis Window: Model Cache Pane: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
No edit summary
imported>Scott
No edit summary
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__TOC__
__TOC__
[[TableOfContents|Table of Contents]] | [[AnalysisWindow_AnalysisFlowChartPane|Previous]] | [[ModelBuilding_PreProcessingMethods|Next]]
[[TableOfContents|Table of Contents]] | [[AnalysisWindow_AnalysisFlowChartPane|Previous]] | [[ModelBuilding_PreProcessingMethods|Next]]


Line 6: Line 7:
Data that is used to create models and predictions during data analysis as well as all of the models and predictions created from this data is automatically cached. After a model is created, the model and the data used to create it are added to the cache. If new data is loaded and a prediction is made, this new data and the prediction are added to the cache. Every time you edit data and create a new model or prediction from the data, each version of the modified data and the corresponding model or prediction are added to the cache. The Model Cache pane displays this complete history of all your cached items-all of the data that was used to create models and predictions during data analysis as well as all of the models and predictions that were created from this data-in a hierarchical view.  
Data that is used to create models and predictions during data analysis as well as all of the models and predictions created from this data is automatically cached. After a model is created, the model and the data used to create it are added to the cache. If new data is loaded and a prediction is made, this new data and the prediction are added to the cache. Every time you edit data and create a new model or prediction from the data, each version of the modified data and the corresponding model or prediction are added to the cache. The Model Cache pane displays this complete history of all your cached items-all of the data that was used to create models and predictions during data analysis as well as all of the models and predictions that were created from this data-in a hierarchical view.  


::''Analysis window Model Cache pane''
:''Analysis window Model Cache pane''


::[[Image:Model_cache_pane.png|247x288px]]
::[[Image:Model_cache_pane.png|247x288px]]
::


::
To reload a previously created model:
::
# Set the Model Cache view to the mode which best organizes the list to help you find the item desired (see the [[AnalysisWindow_ModelCachepane#Model Cache pane view|Model Cache pane view]] descriptions for suggestions.)
# Locate the model to load in the list (Note that after other sorting criteria are met, models on a specific branch are sorted by date in all views.)
# Double-click on the old model to load it into the Analysis window. The calibration data corresponding to the model will also be automatically loaded (if it is available in the cache.) Right-clicking the model will give other options - see [[AnalysisWindow_ModelCachepane#Manipulating cached items|Manipulating cached items]].
For more usage hints, see the [[AnalysisWindow_ModelCachepane#Model Cache pane view|Model Cache pane view]] descriptions below.


Note: By default, the Model Cache pane is turned on when Solo first opens. You can close the Model Cache pane by clicking the Close ("X") button in the upper right hand corner of the pane. To turn the Model Cache on again, on the Tools menu on the Analysis window, click View Cache, and then select a viewing option. Models and data are cached even if the Model Cache pane is not open.
'''Note:''' By default, the Model Cache pane is turned on when Solo first opens. You can close the Model Cache pane by clicking the Close ("X") button in the upper right hand corner of the pane. To turn the Model Cache on again, on the Tools menu on the Analysis window, click View Cache, and then select a viewing option. Models and data are cached even if the Model Cache pane is not open.


Multiple options are available to you for changing the Model Cache view, managing your cache, and manipulating cache items. See:
Multiple options are available to you for changing the Model Cache view, managing your cache, and manipulating cache items. See:


{|
* [[AnalysisWindow_ModelCachepane#Model Cache pane view|Model Cache pane view]].
 
|-
 
|
* [[AnalysisWindow_ModelCachepane#"Model Cache pane view."|"Model Cache pane view."]]
 
|}
 
{|
 
|-
 
|
* [[AnalysisWindow_ModelCachepane#Cache management|Cache management]].
* [[AnalysisWindow_ModelCachepane#Cache management|Cache management]].
|}
{|
|-
|
* [[AnalysisWindow_ModelCachepane#Manipulating cached items|Manipulating cached items]].
* [[AnalysisWindow_ModelCachepane#Manipulating cached items|Manipulating cached items]].
|}


===Model Cache pane view===
===Model Cache pane view===
Line 49: Line 29:
The options to change the Model Cache pane view are found in two locations:
The options to change the Model Cache pane view are found in two locations:


{|
|-
|
* In the Model Cache pane itself under Cache Settings and View
* In the Model Cache pane itself under Cache Settings and View
|}
{|
|-
|
* On the Tools menu (the View Cache option) for the Analysis windows
* On the Tools menu (the View Cache option) for the Analysis windows


|}
:''Options to change the Model Cache pane view''
 
::''Options to change the Model Cache pane view''


::[[Image:Model_cache_settings_options.png|171x56px]]
::[[Image:Model_cache_settings_options.png|171x56px]]
::
::
::


You can select from three different organizational views:
You can select from three different organizational views:


{|
|-
|
* View Cache by Lineage-In the View Cache by Lineage view, the cache items are sorted by the parent data item. Under the parent data item, the child items (modified data, model, and predictions) are sorted by the timestamps at each modification point.  
* View Cache by Lineage-In the View Cache by Lineage view, the cache items are sorted by the parent data item. Under the parent data item, the child items (modified data, model, and predictions) are sorted by the timestamps at each modification point.  
: This is a convenient view to use in identifying a set of models which were all created from a specific data set or ''version'' of a data set (such as a specific data set with different sets of included variables and/or samples.)


|}
:''View Cache by Lineage view''
 
::''View Cache by Lineage view''


::[[Image:Model_cache_view_lineage.png|247x288px]]
::[[Image:Model_cache_view_lineage.png|247x288px]]
::
{|


|-
|
* View Cache by Date-In the View Cache by Date view, all cached items are simply sorted by creation date in chronological order.
* View Cache by Date-In the View Cache by Date view, all cached items are simply sorted by creation date in chronological order.
: This is a convenient view to use when attempting to locate a model or data which was used on a specific date. For example, to reload a model which you knew was built yesterday, switch to the Date view, locate yesterday's date, and expand the tree. All data and models used on that day will be listed. Reload any model by double-clicking it.


|}
:''View Cache by Date view''
 
::''View Cache by Date view''


::[[Image:Model_cache_view_date.png|247x288px]]
::[[Image:Model_cache_view_date.png|247x288px]]
::


::
::
{|
|-
|
* View Cache by Type-In the View Cache by Type view, all cached items are simply sorted by object type-data, model, or prediction.
* View Cache by Type-In the View Cache by Type view, all cached items are simply sorted by object type-data, model, or prediction.
: This is a convenient view to use when attempting to locate a specific type of model when the data used and model's created date are not known. All data, models, and predictions are listed under their own branch, and then sorted by name (for data), type (for models and predictions), and date. For example, to locate an MCR model you know you created on some previous date, switch to the Type view, expand the Models branch, and locate the MCR models in that branch. You can then reload any model by double-clicking it.


|}
:''View Cache by Type view''
 
::''View Cache by Type view''


::[[Image:Model_cache_view_type.png|247x288px]]
::[[Image:Model_cache_view_type.png|247x288px]]
::


===Cache management===
===Cache management===
Line 126: Line 63:
Several options are available to you for managing your cache. You can modify all of these options in the Options dialog box.
Several options are available to you for managing your cache. You can modify all of these options in the Options dialog box.


Note: For a detailed discussion about the Options dialog box, see [[Solo_CommonApplicationFeatures|Options dialog box]].
'''Note:''' For a detailed discussion about the Options dialog box, see [[Solo_CommonApplicationFeatures|Options dialog box]].


{|  
{|  


|-
|- valign="top"


|1.
|1.
Line 140: Line 77:
{| style="margin-left:18pt"   
{| style="margin-left:18pt"   


|-
|- valign="top"


|
|
Line 147: Line 84:
|}
|}


::''Cache Settings and View options''
:''Cache Settings and View options''


::[[Image:Edit_Model_Cache_settings_paneoptions.png|232x122px]]
::[[Image:Edit_Model_Cache_settings_paneoptions.png|232x122px]]
Line 157: Line 94:
{| style="margin-left:18pt"   
{| style="margin-left:18pt"   


|-
|- valign="top"


|
|
Line 166: Line 103:
::The Options dialog box for the Model Cache pane opens.
::The Options dialog box for the Model Cache pane opens.


::''Options dialog box''
:''Options dialog box''


::[[Image:Options_Model_Cache_dialogbox.png|487x295px]]
::[[Image:Options_Model_Cache_dialogbox.png|650px]]
::
::


Line 176: Line 113:
{|  
{|  


|-
|- valign="top"


|2.
|2.
Line 206: Line 143:
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Controls the operation of the cache. "On" records all data, models, and predictions. "readonly" locks down the cache and prevents recording to the cache and clearing of the cache.
Controls the operation of the cache. "On" records all data, models, and predictions. "readonly" locks down the cache and prevents recording to the cache and clearing of the cache.
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
cachefolder
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Specifies the folder in which all of your cached information is stored. By default, the cached items that do not exceed the maxdatasize value (see [[AnalysisWindow_ModelCachepane#maxdatasize|maxdatasize]] below) are stored automatically in your system's TEMP folder and remain in this folder as long as they do not exceed the maxage value. (See [[AnalysisWindow_ModelCachepane#maxage|maxage]] below.) For all operating systems other than Macintosh (a "Mac"), this means that even if you close Solo (or crash and reboot your computer, or just reboot your computer), the cached items are immediately available when you restart Solo or your computer.
Note: If you are running Solo on a Mac, the first time that you cache an item, you are prompted to choose a folder other than the TEMP folder. Because the TEMP folder is sometimes deleted when you restart a Mac, if you are running Solo on a Mac, you should specify a different setting for your cachefolder.
</td>
</td>
</tr>
</tr>
Line 223: Line 151:
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Specifies an optional subfolder within the cachefolder for holding the cached items. The default name for project is "general." You can use the project setting to separate cached items among different work projects.  
Specifies an optional subfolder within the cachefolder for holding the cached items. The default name for project is "general." You can use the project setting to separate cached items among different work projects.  
Note: No option is available in Solo to delete a project folder after you create it. You can delete old project folders only by manually locating the project folder on your computer and deleting the folder.
'''Note: '''No option is available in Solo to delete a project folder after you create it. You can delete old project folders only by manually locating the project folder on your computer and deleting the folder.
Note: You can also change value for the project setting using the Change Project option under Cache Settings and View in the Model Cache pane.
'''Note:''' You can also change value for the project setting using the Change Project option under Cache Settings and View in the Model Cache pane.
</td>
</td>
</tr>
</tr>
Line 233: Line 161:
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
The maximum number of days an item is saved in the cache. An item that is older than this value is permanently deleted from the cache.  
The maximum number of days an item is saved in the cache. An item that is older than this value is permanently deleted from the cache.  
Note: See [[AnalysisWindow_ModelCachepane#"Manipulating cached items"|"Manipulating cached items"]] below for information about saving cached items to a location other than the cachefolder.
'''Note:''' See [[AnalysisWindow_ModelCachepane#Manipulating cached items|"Manipulating cached items"]] below for information about saving cached items to a location other than the cachefolder.
</td>
</td>
</tr>
</tr>
Line 270: Line 198:
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Loads the selected cached item into the Analysis window. By default, if no data is loaded into the Analysis window, then the cached item is loaded into the X calibration component; otherwise, you are prompted to override the loaded data or load the data to another location.  
Loads the selected cached item into the Analysis window. By default, if no data is loaded into the Analysis window, then the cached item is loaded into the X calibration component; otherwise, you are prompted to override the loaded data or load the data to another location.  
Note: You can also double-click a cached item to load it into the Analysis window.
'''Note:''' You can also double-click a cached item to load it into the Analysis window.
</td>
</td>
</tr>
</tr>
Line 306: Line 234:
</tr>
</tr>
</table>
</table>
===Moving/Changing a Cache===
You can copy and move your Model Cache folder to a new location without any special consideration. When moving to a new computer, copy the cache folder to the new EVRI [[evridir | home folder]] and restart Matlab. Once the folder is in the new location select '''File/Change Cache''' from the Workspace Browser and select the new folder. The cache will refresh automatically.
From the Workspace Browser '''File>Change Cache''' menu item. From the Matlab command line the cache folder location can be change with:
modelcache('changecachedir','path/to/new/location')
If you move your modelcache and experience problems getting the Model Cache to recognize the new location you may need to clear your preferences (matlabprefs.mat) file. Contact helpdesk@eigenvector.com for more details on how to do this.
===Exporting and Importing Models===
Models can be exported from the cache via the right-click menu '''Export For Cache''' item. This will export the model and the data used to create it (if available) to a MAT file. The file can then be Imported into a different cache. To import a cache model, expand the Cache Settings and View leaf and click the '''Import Model' leaf.

Revision as of 17:09, 13 November 2013

Table of Contents | Previous | Next

Analysis window Model Cache pane

Data that is used to create models and predictions during data analysis as well as all of the models and predictions created from this data is automatically cached. After a model is created, the model and the data used to create it are added to the cache. If new data is loaded and a prediction is made, this new data and the prediction are added to the cache. Every time you edit data and create a new model or prediction from the data, each version of the modified data and the corresponding model or prediction are added to the cache. The Model Cache pane displays this complete history of all your cached items-all of the data that was used to create models and predictions during data analysis as well as all of the models and predictions that were created from this data-in a hierarchical view.

Analysis window Model Cache pane
Model cache pane.png

To reload a previously created model:

  1. Set the Model Cache view to the mode which best organizes the list to help you find the item desired (see the Model Cache pane view descriptions for suggestions.)
  2. Locate the model to load in the list (Note that after other sorting criteria are met, models on a specific branch are sorted by date in all views.)
  3. Double-click on the old model to load it into the Analysis window. The calibration data corresponding to the model will also be automatically loaded (if it is available in the cache.) Right-clicking the model will give other options - see Manipulating cached items.

For more usage hints, see the Model Cache pane view descriptions below.

Note: By default, the Model Cache pane is turned on when Solo first opens. You can close the Model Cache pane by clicking the Close ("X") button in the upper right hand corner of the pane. To turn the Model Cache on again, on the Tools menu on the Analysis window, click View Cache, and then select a viewing option. Models and data are cached even if the Model Cache pane is not open.

Multiple options are available to you for changing the Model Cache view, managing your cache, and manipulating cache items. See:

Model Cache pane view

The options to change the Model Cache pane view are found in two locations:

  • In the Model Cache pane itself under Cache Settings and View
  • On the Tools menu (the View Cache option) for the Analysis windows
Options to change the Model Cache pane view
Model cache settings options.png

You can select from three different organizational views:

  • View Cache by Lineage-In the View Cache by Lineage view, the cache items are sorted by the parent data item. Under the parent data item, the child items (modified data, model, and predictions) are sorted by the timestamps at each modification point.
This is a convenient view to use in identifying a set of models which were all created from a specific data set or version of a data set (such as a specific data set with different sets of included variables and/or samples.)
View Cache by Lineage view
Model cache view lineage.png
  • View Cache by Date-In the View Cache by Date view, all cached items are simply sorted by creation date in chronological order.
This is a convenient view to use when attempting to locate a model or data which was used on a specific date. For example, to reload a model which you knew was built yesterday, switch to the Date view, locate yesterday's date, and expand the tree. All data and models used on that day will be listed. Reload any model by double-clicking it.
View Cache by Date view
Model cache view date.png
  • View Cache by Type-In the View Cache by Type view, all cached items are simply sorted by object type-data, model, or prediction.
This is a convenient view to use when attempting to locate a specific type of model when the data used and model's created date are not known. All data, models, and predictions are listed under their own branch, and then sorted by name (for data), type (for models and predictions), and date. For example, to locate an MCR model you know you created on some previous date, switch to the Type view, expand the Models branch, and locate the MCR models in that branch. You can then reload any model by double-clicking it.
View Cache by Type view
Model cache view type.png

Cache management

Several options are available to you for managing your cache. You can modify all of these options in the Options dialog box.

Note: For a detailed discussion about the Options dialog box, see Options dialog box.

1. Do one of the following:
  • In the Model Cache pane, expand the Cache Settings and View option, and under this option, click Edit Model Cache Settings.
Cache Settings and View options
Edit Model Cache settings paneoptions.png
  • On the Analysis window menu, click Edit > Options > Model Cache Settings.
The Options dialog box for the Model Cache pane opens.
Options dialog box
Options Model Cache dialogbox.png
2. Modify the value for any option, and then click OK.
The Options dialog box closes and you return to the Model Cache pane. Any changes that you made are effective immediately.

Option

Description

cache

Controls the operation of the cache. "On" records all data, models, and predictions. "readonly" locks down the cache and prevents recording to the cache and clearing of the cache.

project

Specifies an optional subfolder within the cachefolder for holding the cached items. The default name for project is "general." You can use the project setting to separate cached items among different work projects. Note: No option is available in Solo to delete a project folder after you create it. You can delete old project folders only by manually locating the project folder on your computer and deleting the folder. Note: You can also change value for the project setting using the Change Project option under Cache Settings and View in the Model Cache pane.

maxage

The maximum number of days an item is saved in the cache. An item that is older than this value is permanently deleted from the cache. Note: See "Manipulating cached items" below for information about saving cached items to a location other than the cachefolder.

maxdatasize

Specifies the maximum size of a data item (in total number of table elements) that can be stored in the cache.

Manipulating cached items

You can right-click on an entry for a cached item Model Cache pane to open a context menu that contains options for manipulating the item.

Menu Option

Description

Load Item

Loads the selected cached item into the Analysis window. By default, if no data is loaded into the Analysis window, then the cached item is loaded into the X calibration component; otherwise, you are prompted to override the loaded data or load the data to another location. Note: You can also double-click a cached item to load it into the Analysis window.

Show Item

Opens and displays the selected item in a separate window-either the DataSet Editor window or the Model Reader window.

Save Cached Item As

Save the cached item to the workspace or to a file.

Open in New Window

Opens the cached item in a new Analysis window.

Rename

Rename the cached item.

Moving/Changing a Cache

You can copy and move your Model Cache folder to a new location without any special consideration. When moving to a new computer, copy the cache folder to the new EVRI home folder and restart Matlab. Once the folder is in the new location select File/Change Cache from the Workspace Browser and select the new folder. The cache will refresh automatically.

From the Workspace Browser File>Change Cache menu item. From the Matlab command line the cache folder location can be change with:

modelcache('changecachedir','path/to/new/location')

If you move your modelcache and experience problems getting the Model Cache to recognize the new location you may need to clear your preferences (matlabprefs.mat) file. Contact helpdesk@eigenvector.com for more details on how to do this.

Exporting and Importing Models

Models can be exported from the cache via the right-click menu Export For Cache item. This will export the model and the data used to create it (if available) to a MAT file. The file can then be Imported into a different cache. To import a cache model, expand the Cache Settings and View leaf and click the Import Model' leaf.