Differences

This shows you the differences between two versions of the page.

command_line [2012/07/18 14:53]
oleksiy [Background processing]
command_line [2014/02/04 09:08] (current)
oleksiy [Batch mode export]
Line 1: Line 1:
 ===== Command line ===== ===== Command line =====
  
 +You can run your GMDH Shell project in the background mode using the command line. In this mode GMDH Shell works like a command line tool without any interaction with the user. 
  
- +The easiest way to run GMDH Shell in the background mode is to use the key **''/auto''**. 
-==== Background processing ==== +Example: <code>;"GMDH Shell.exe" c:\Path\FileName.gsp /auto</code>
- +
-In the background mode GMDH Shell performs modeling simulation without any interaction. The easiest way to launch the program in the background mode is to use the command line key **''/auto''**  +
- +
- +
-Use of the key **''/auto''** executes the project located in the current directory. So, the usual way for background processing is to configure a project visually and then run it from the command line. Example: "''"GMDH Shell.exe" /auto''" No other settings required. +
- +
- +
- +
-If the project is located in another directory, you'll need to run "''"GMDH Shell.exe"; /auto:C\MyData''". Of course, there should be a configured project (''gmdh_shell.ini'') in that directory. +
- +
  
 == Host commands ==  == Host commands == 
  
  
- +| **''/auto''** | Runs specified project without user interaction. Example:\\ ''<nowiki>"GMDH Shell.exe" c:\MyData\file.gsp /auto</nowiki>'' | 
-| **''/auto''** | Runs the project located in the current directory. Example: "''GMDH Shell.exe /auto''+| **''/save:FileName.gsp''** | Saves simulation results. Example:\\ ''<nowiki>"GMDH Shell.exe" file.gsp /auto /save:result.gsp&lt;/nowiki>'' 
- +| **''/semiauto''** | Semi-automatic mode. Same as ''/auto'', but permits interaction with the user. | 
-| **''/auto:ProjectPath''** | Runs a project located in **''ProjectPath''**. Example:\\ "''GMDH Shell.exe /auto:C:\MyData''| +| **''/apply:FileName.gsp''** | Applies models already saved in the project file. Example:\\ ''<nowiki>"GMDH Shell.exe" /apply:C:\MyData\project.gsp</nowiki>'' |
- +
-| **''/save:FileName.model''** | Saves a binary simulation file. Example:\\ "''GMDH Shell.exe /save:C:\MyData\TimeSeries.model''&quot; | +
- +
-| **''/semiauto''**\\ **''/semiauto:ProjPath''** | Semi-automatic mode. Same as ''/auto'', but does not forbid interaction with user. | +
  
  
 == How to recover command-line options from a plug-in == == How to recover command-line options from a plug-in ==
  
- +  Look into ''.gsp'' project file. Though the file is binary, for your convenience all plug-ins’ settings are kept there in human-readable XML. Find an appropriate section, e.g. ''<nowiki><Storage file="BasePluginfeature="1" description="Time series modeling"></nowiki>''. Important: **Despite XML section.gsp file is binary, do not edit the file!** 
- +  - All settings stored in the XML section are configurable from the command line. For example, command line equivalent of **''<task>future</task>''** is **''/pr.task:future''**.
-  Get plugin'file and number in menu File Configuration. For example, "Time series preprocessis "BasePlugin:1"+
- +
-  - Look into ''gmdh_shell.ini'' file. All plug-ins' settings are kept there. Find a section with appropriate name. +
- +
-  - All settings stored in that section are configurable from command line. For example, to set **''step''** to 10, write **''/pr.step:10''**. +
     * ''/im'' — importer     * ''/im'' — importer
- 
     * ''/pr'' — preprocessor     * ''/pr'' — preprocessor
- 
     * ''/ca'' — solver     * ''/ca'' — solver
- 
     * ''/po'' — postprocessor     * ''/po'' — postprocessor
- 
     * ''/ex'' — exporter     * ''/ex'' — exporter
 +  - Some settings are stored in the so-called “shared storage”, accessible to several plug-ins. For example: ''<nowiki><Storage name="gs.prepro"><decompositionlimit>0</decompositionlimit></nowiki>'' → ''/pr.gs.prepro.decompositionlimit:0''
  
- +:!: The plug-in may have some extra options not stored in the ''.gsp'', but listed in the documentation.
- +
-:!: The plug-in may have some extra options that aren't stored in ''gmdh_shell.ini''.+
  
  
  
 == Batch-mode export == == Batch-mode export ==
- 
  
  
 | **''/noexport''** | Prevents the export plug-in from exporting simulation results. | | **''/noexport''** | Prevents the export plug-in from exporting simulation results. |
- 
  
  
 == Batch-mode exporter: Export forecast == == Batch-mode exporter: Export forecast ==
  
-| **''/ex.file:FPath''** | Saves result to  FPath. Example:\\ "''GMDH Shell.exe /auto /ex.file:C:\MyData\example.txt''&quot; |+| **''/ex.file:FPath''** | Saves result to  FPath. Example:\\ ''<nowiki>"GMDH Shell.exe" file.gsp /auto /ex.file:C:\MyData\example.txt&lt;/nowiki>'' |
  
  
Line 73: Line 45:
  
  
- +| **''/im.file:FPath''** | import file from path FPath. Example:\\ ''<nowiki>"GMDH Shell.exe" file.gsp /auto /im.file:C:\MyData\example.xls&lt;/nowiki>'' |
-| **''/im.file:FPath''** | import file from path FPath. Example:\\ "''GMDH Shell.exe /auto /im.file:C:\MyData\example.xls''&quot; |+
  
  
Line 82: Line 53:
  
  
-| **''/pr.calc:n''** | Number of forecasts to simulate = ''n''. | +| **''/pr.backtest:n''** | Number of backtests to simulate = ''n''. |
 | **''/pr.skip:n''** | Skip observations  = ''n''. | | **''/pr.skip:n''** | Skip observations  = ''n''. |
 +| **''/pr.gs.prepro.ts.shift:a,b,c''** \\ **''/pr.horizon:a,b,c''** | Forecast horizons  = ''a,b,c''. |
  
  
Line 91: Line 62:
  
  
- +| **''/pr.unk:n''** | Number of unknown values = ''n''. | 
-| **''/pr:unk:n''** | Number of unknown values = ''n''. | +| **''/pr.unit:sample''** | Unit of ''/pr:unk''. Either ''sample'' or ''percent''. |
- +
-| **''/pr:limit:n''** | Calculate only (''0=all'') = ''n''. | +
  
  
Line 101: Line 69:
  
  
 +| **''/ca.ncpu:n''** | Number of parallel threads |
  
-| **''/ca.ncpu:n''** | Number of parallel threads | 
  
  
 +==== Export module ====
  
-== Solver: Combinatorial HPC. (GMDH Shell Enterprise edition only) ==+**Data Science** and **Load forecasting** editions of GMDH Shell are supplied with an export module that outputs predictions in the command line mode. C++ source codes of the module - a [[http://www.codeblocks.org|CodeBlocks]] project is available in the installation directory "..\Plugins\ExportForecast-source.zip".
  
  
 +The module automatically performs export of predictions when GMDH Shell is launched using the command line. Predictions are saved to **simulation_result.txt** in the project directory.
  
-| **''/ca.ncpu:n''** | Number of parallel tasks. | 
  
-| **''/ca.reserve:b''** | Reserve cluster, Yes: ''b = 1''; No: ''b = 0''. | 
  
  
You are here: IntroductionCommand line
CC Attribution-Noncommercial 3.0 Unported
Valid CSS Driven by DokuWiki Recent changes RSS feed Valid XHTML 1.0