-
Notifications
You must be signed in to change notification settings - Fork 149
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/ddobric/neocortexapi
- Loading branch information
Showing
26 changed files
with
4,946 additions
and
888 deletions.
There are no files selected for viewing
62 changes: 62 additions & 0 deletions
62
source/Documentation/ML2223-11 Improve UnitTests for Temporal Memory Algorithm.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Improve UnitTests for Temporal Memory Algorithm | ||
| ## Introduction | ||
| We describe the approach to evaluate the performance of given Temporal Memory algorithm. The project's objective was to test the algorithm's ability to learn and predict spatio-temporal patterns. To achieve this, we performed a series of experiments using unit tests, which allowed us to systematically evaluate the algorithm's behavior under different conditions. All the Unit Tests which have been build on existing algorithm can be found [_here_](https://github.com/Mostainahmed/variable-i/blob/f0e1d25aa6bead46ca2cc20be7fa2dcec9131b5a/source/UnitTestsProject/TemporalMemoryTest2.cs) | ||
|
|
||
| ## Brief Sumary | ||
| Here the summary of the improvement of UNIT TESTS on TemporalMemory Algorithm done so far in this project: | ||
|
|
||
| 1. Creation, removal, and update of synapses in distal segments | ||
| 2. Growth of new dendrite segments when no or multiple matching segments are found | ||
| 3. Activation of cells in columns and detection/handling of duplicate active columns | ||
| 4. Learning and recalling patterns of sequences with different sparsity rates | ||
| 5. Initialization of TemporalMemory with custom parameters (number of cells per column, number of column dimensions) | ||
| 6. Adaptation of segments and increase of permanence of active synapses | ||
| 7. Limitation of the number of active cells per column | ||
| 8. Retrieval of winner cells from TemporalMemory Compute | ||
| 9. Least used cell selection | ||
| 10. Using different parameters for existing unit tests to re-enforce the testing. | ||
| 11. Fix one issue with a method GetLeastUsedCell in TemporalMemory and ran UnitTest on it. | ||
| 12. Fix some typo on Documentation of TemporalMemoryTest and TemporalMemory file | ||
|
|
||
| ## Architecture | ||
| Here is the general architecture of this project, | ||
|
|
||
|  | ||
|
|
||
| ## Run the project | ||
|
|
||
| In order to run the project, [repository](https://github.com/Mostainahmed/variable-i.git) can be cloned in the local system. After that, go to the source folder | ||
|
|
||
|  | ||
|
|
||
| Open neocortexapi.sln with visual studio. | ||
|
|
||
|  | ||
|
|
||
| Then in solution explorer go to unit test project and open TemporalMemoryTest2.cs | ||
|
|
||
|  | ||
|
|
||
| Now click on the Test tab on the toolbar and click on the Test Explorer in order to open the Test Explorer section | ||
|
|
||
|  | ||
|
|
||
| Now a tab like this should be seen in the visual studio | ||
|
|
||
|  | ||
|
|
||
| Then in Test Explorer click on the marked "Section 1" which will open a filter and make sure that the marked "Section 2" is checked. | ||
|
|
||
|  | ||
|
|
||
| Now scroll down in the Test Explorer and find the _TemporalMemoryTest2_ file and expand it until a series view | ||
|
|
||
|  | ||
|
|
||
| Right click on the TemporalMemoryTest2 file and click run as shown in below figure "Section 1". Now the test cases will start to execute and the final result can be seen in marked "Section 2". The result section consists of total run time, total number of passed test cases, number of skipped test cases and number of failed test cases. | ||
|
|
||
|  | ||
|
|
||
| In addition, all the successfull Unit Tests are in below at a glance, | ||
|
|
||
|  |
Binary file added
BIN
+220 KB
source/Documentation/ML2223-11 Improve UnitTests for Temporal Memory Algorithm.pdf
Binary file not shown.
233 changes: 233 additions & 0 deletions
233
source/Documentation/ML2223-6 Unit-Tests for SpatialPooler AdaptSynapses.md
Large diffs are not rendered by default.
Oops, something went wrong.
Binary file added
BIN
+500 KB
source/Documentation/ML2223-6 Unit-Tests for SpatialPooler AdaptSynapses.pdf
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
source/Samples/NeoCortexApiAnomaly/AnomalyDetectionSample.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <OutputType>Exe</OutputType> | ||
| <TargetFramework>net7.0</TargetFramework> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <Nullable>enable</Nullable> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="NeoCortexApi" Version="1.1.4" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
25 changes: 25 additions & 0 deletions
25
source/Samples/NeoCortexApiAnomaly/AnomalyDetectionSample.sln
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
|
|
||
| Microsoft Visual Studio Solution File, Format Version 12.00 | ||
| # Visual Studio Version 17 | ||
| VisualStudioVersion = 17.5.33424.131 | ||
| MinimumVisualStudioVersion = 10.0.40219.1 | ||
| Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AnomalyDetectionSample", "AnomalyDetectionSample.csproj", "{F562704E-658F-410F-BC67-4DE467BE44FC}" | ||
| EndProject | ||
| Global | ||
| GlobalSection(SolutionConfigurationPlatforms) = preSolution | ||
| Debug|Any CPU = Debug|Any CPU | ||
| Release|Any CPU = Release|Any CPU | ||
| EndGlobalSection | ||
| GlobalSection(ProjectConfigurationPlatforms) = postSolution | ||
| {F562704E-658F-410F-BC67-4DE467BE44FC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {F562704E-658F-410F-BC67-4DE467BE44FC}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {F562704E-658F-410F-BC67-4DE467BE44FC}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {F562704E-658F-410F-BC67-4DE467BE44FC}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| EndGlobalSection | ||
| GlobalSection(SolutionProperties) = preSolution | ||
| HideSolutionNode = FALSE | ||
| EndGlobalSection | ||
| GlobalSection(ExtensibilityGlobals) = postSolution | ||
| SolutionGuid = {802EED87-EAB7-4E5A-B5A5-1ABEFD119DE2} | ||
| EndGlobalSection | ||
| EndGlobal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| using System; | ||
|
|
||
| namespace AnomalyDetectionSample | ||
| { | ||
| /// <summary> | ||
| /// Reads a single CSV file and returns its contents as a list of sequences. | ||
| /// </summary> | ||
| public class CSVFileReader | ||
| { | ||
| private string _filePathToCSV; | ||
|
|
||
| /// <summary> | ||
| /// Creates a new instance of the CSVFileReader class with the provided file path to the constructor. | ||
| /// </summary> | ||
| /// <param name="filePathToCSV">The path to the CSV file to be read.</param> | ||
| public CSVFileReader(string filePathToCSV) | ||
| { | ||
| _filePathToCSV = filePathToCSV; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Reads the CSV file at the file path specified in the constructor, | ||
| /// and returns its contents as a list of sequences. | ||
| /// </summary> | ||
| /// <returns>A list of sequences contained in the CSV file.</returns> | ||
| public List<List<double>> ReadFile() | ||
| { | ||
| List<List<double>> sequences = new List<List<double>>(); | ||
| string[] csvLines = File.ReadAllLines(_filePathToCSV); | ||
| // Loop through each line in the CSV File | ||
| for (int i = 0; i < csvLines.Length; i++) | ||
| { | ||
| // Current line is split into an array of columns | ||
| string[] columns = csvLines[i].Split(new char[] { ',' }); | ||
| List<double> sequence = new List<double>(); | ||
| // Loop through each column in the current line | ||
| for (int j = 0; j < columns.Length; j++) | ||
| { | ||
| // Value of column is parsed as double and added to sequence | ||
| // if it fails then exception is thrown | ||
| if (double.TryParse(columns[j], out double value)) | ||
| { | ||
| sequence.Add(value); | ||
| } | ||
| else | ||
| { | ||
| throw new ArgumentException($"Non-numeric value found! Please check the file."); | ||
| } | ||
| } | ||
| sequences.Add(sequence); | ||
| } | ||
| return sequences; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// This method reads the CSV file at the file path passed on to the constructor, | ||
| /// and outputs its contents to the console. | ||
| /// </summary> | ||
| public void CSVSequencesConsoleOutput() | ||
| { | ||
| List<List<double>> sequences = ReadFile(); | ||
| // Looping through each sequence and displaying it in the console | ||
| for (int i = 0; i < sequences.Count; i++) | ||
| { | ||
| Console.Write("Sequence " + (i + 1) + ": "); | ||
| foreach (double number in sequences[i]) | ||
| { | ||
| Console.Write(number + " "); | ||
| } | ||
| Console.WriteLine(""); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Trims a random number of elements (between 1 and 4) from the beginning of each sequence in a list of sequences. | ||
| /// </summary> | ||
| /// <param name="sequences">The list of sequences to trim.</param> | ||
| /// <returns>A new list of trimmed sequences.</returns> | ||
| public static List<List<double>> TrimSequences(List<List<double>> sequences) | ||
| { | ||
| Random rnd = new Random(); | ||
| List<List<double>> trimmedSequences = new List<List<double>>(); | ||
|
|
||
| foreach (List<double> sequence in sequences) | ||
| { | ||
| // Generate a random number between 1 and 4 | ||
| int numElementsToRemove = rnd.Next(1, 5); | ||
| List<double> trimmedSequence = sequence.Skip(numElementsToRemove).ToList(); | ||
| trimmedSequences.Add(trimmedSequence); | ||
| } | ||
|
|
||
| return trimmedSequences; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| using System; | ||
|
|
||
| namespace AnomalyDetectionSample | ||
| { | ||
| /// <summary> | ||
| /// Reads the CSV files inside a folder and returns its contents as a list of sequences. | ||
| /// </summary> | ||
| public class CSVFolderReader | ||
| { | ||
| private string _folderPathToCSV; | ||
|
|
||
| /// <summary> | ||
| /// Creates a new instance of the CSVFolderReader class with the provided file path to the constructor. | ||
| /// </summary> | ||
| /// <param name="folderPathToCSV">The path to the folder containing the CSV files.</param> | ||
| public CSVFolderReader(string folderPathToCSV) | ||
| { | ||
| _folderPathToCSV = folderPathToCSV; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Reads all CSV files in the folder, path to the folder is specified in the constructor, | ||
| /// and returns its contents as a list of sequences. | ||
| /// </summary> | ||
| /// <returns>A list of sequences contained in the CSV files present in the folder.</returns> | ||
| public List<List<double>> ReadFolder() | ||
| { | ||
| List<List<double>> folderSequences = new List<List<double>>(); | ||
|
|
||
| // All the CSV files present inside the folder are taken | ||
| string[] fileEntries = Directory.GetFiles(_folderPathToCSV, "*.csv"); | ||
|
|
||
| // Iterating through each CSV file inside the folder | ||
| foreach (string fileName in fileEntries) | ||
| { | ||
| string[] csvLines = File.ReadAllLines(fileName); | ||
| List<List<double>> sequencesInFile = new List<List<double>>(); | ||
|
|
||
| // Looping through each line in the current CSV file | ||
| for (int i = 0; i < csvLines.Length; i++) | ||
| { | ||
| string[] columns = csvLines[i].Split(new char[] { ',' }); | ||
| List<double> sequence = new List<double>(); | ||
|
|
||
| // Loop through each column in the current line | ||
| for (int j = 0; j < columns.Length; j++) | ||
| { | ||
| // Value of column is parsed as double and added to sequence | ||
| // if it fails then exception is thrown | ||
| if (double.TryParse(columns[j], out double value)) | ||
| { | ||
| sequence.Add(value); | ||
| } | ||
| else | ||
| { | ||
| throw new ArgumentException($"Non-numeric value found! Please check file: {fileName}."); | ||
| } | ||
| } | ||
| sequencesInFile.Add(sequence); | ||
| } | ||
| folderSequences.AddRange(sequencesInFile); | ||
| } | ||
| return folderSequences; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// This method reads all CSV files in the folder path passed on to the constructor, | ||
| /// and outputs its contents to the console. | ||
| /// </summary> | ||
| public void CSVSequencesConsoleOutput() | ||
| { | ||
| List<List<double>> sequences = ReadFolder(); | ||
| // Looping through each sequence and displaying it in the console | ||
| for (int i = 0; i < sequences.Count; i++) | ||
| { | ||
| Console.Write("Sequence " + (i + 1) + ": "); | ||
| foreach (double number in sequences[i]) | ||
| { | ||
| Console.Write(number + " "); | ||
| } | ||
| Console.WriteLine(""); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Trims a random number of elements (between 1 and 4) from the beginning of each sequence in a list of sequences. | ||
| /// </summary> | ||
| /// <param name="sequences">The list of sequences to trim.</param> | ||
| /// <returns>A new list of trimmed sequences.</returns> | ||
| public static List<List<double>> TrimSequences(List<List<double>> sequences) | ||
| { | ||
| Random rnd = new Random(); | ||
| List<List<double>> trimmedSequences = new List<List<double>>(); | ||
|
|
||
| foreach (List<double> sequence in sequences) | ||
| { | ||
| // Generate a random number between 1 and 4 | ||
| int numElementsToRemove = rnd.Next(1, 5); | ||
| List<double> trimmedSequence = sequence.Skip(numElementsToRemove).ToList(); | ||
| trimmedSequences.Add(trimmedSequence); | ||
| } | ||
|
|
||
| return trimmedSequences; | ||
| } | ||
|
|
||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| using System; | ||
|
|
||
| namespace AnomalyDetectionSample | ||
| { | ||
| /// <summary> | ||
| /// Converts a list of sequences to a dictionary of sequences for facilitating HTM Engine training. | ||
| /// </summary> | ||
| public class CSVToHTMInput | ||
| { | ||
| /// <summary> | ||
| /// Builds a dictionary of sequences from a list of sequences. | ||
| /// An unique key is added, which is later used as an input for HtmClassifier. | ||
| /// </summary> | ||
| /// <param name="sequences">A list of sequences read from CSV file/files in a folder.</param> | ||
| /// <returns>A dictionary of sequences required for HTM Engine training.</returns> | ||
| public Dictionary<string, List<double>> BuildHTMInput(List<List<double>> sequences) | ||
| { | ||
| Dictionary<string, List<double>> dictionary = new Dictionary<string, List<double>>(); | ||
| for (int i = 0; i < sequences.Count; i++) | ||
| { | ||
| // Unique key created and added to dictionary for HTM Input | ||
| string key = "S" + (i + 1); | ||
| List<double> value = sequences[i]; | ||
| dictionary.Add(key, value); | ||
| } | ||
| return dictionary; | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.