GithubHelp home page GithubHelp logo

tanya-jp / ann-cas741 Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 30.04 MB

Project of Development of Scientific Computing Software Course @ McMaster University

License: Other

TeX 23.60% Python 76.40%
artificial-neural-networks image-classification software-design software-development software-documentation unit-testing

ann-cas741's People

Contributors

tanya-jp avatar

Stargazers

 avatar

Watchers

 avatar

ann-cas741's Issues

SRS - Review 5

In 3.1, the both user responsibilities you mentioned look the same.

MIS -Independent Module for Connecting Input and Output Modules

To improve modularity, it's suggested to connect the Input and Output Modules via an independent module, such as a Control Module, rather than integrating the Input Module directly within the Control Module. This could clarify module interactions and responsibilities.

Typos in MIS

In section 8.3.2 exported access programs, there is a set_class method, while in 8.4.4 there is a get_class method, I guess one of them is a typo?
Also in 14.4.5 you misspell "calculate".

MG secrets being nouns

As in the checklist: "Secrets are nouns (generally)"

It would be better if the secrets in section 7.3.1, 7,3.2 could be phrased as nouns.

SRS - Review 6

In functional requirements R2 is "Verify the given inputs are in correct form and satify the required physical constraints given in the Table 1. The system provides feedback by displaying the classification esults for user confirmation." Which seems need to be break to 2 requirements.

MG - Use Hierarch Diagram

To make the diagram easier to understand and show how the modules interact more clearly, it's recommended to redraw Figure 1 with all arrows pointing downwards.

VnV Review_Indentation Issue

In Section 3.5, the indentation of the paragraphs is inconsistent. Some sentences are indented, while others are not.

MIS local functions

How are the local functions used in sections 12.4.5 and 13.4.5? I might be wrong but I thought they should be related to the export access program somehow. Feel like the local functions you write are more like the functions you are going to implement in the software.
Also, there are functions rgb2gray, prep pixels, and flat data in both 12.4.5 and 13.4.5 with the same name, are they going to be overwritten?

Modules consistency MG+MIS

There are lots of modules in your project so I think it might be helpful to order modules logically? Also in your use hierarchy in MG, the Input Preparing and Preprocessing Modul uses the Input Image Module, but this is not shown in the MIS (Section 12.2)

VnV Review_Survey Clarification

In Table 3, Question 5 appears somewhat ambiguous. Is it referring to the system's ability to recover from errors? Additionally, regarding Question 9, is it intended to highlight potential drawbacks of the system? If so, this seems slightly similar to Question 10. Could you please clarify?

SRS - Review 3

The Scope of the program could be more specific. You can mention the type of images your program works with, for example it only works with images that consist of only one object.

SRS - Review 1

In Mathematical Notation, Typographic Conventions you mentioned the matrix and vectors are shown by bold letters but in the doc there are not.
SRS_Taniya.pdf

MIS - Environment Variables for Loading Pictures

The documentation does not mention Environment Variables for loading pictures from outside the application scope. Including this information could enhance the document by clearly outlining how external resources are managed.

VnV Review_Suggestion for Content Section

I noticed that there are no figures presented in your document. It might be worth considering the removal of "List of Figures" section from the Table of Contents if it remains unused.

Transition in MIS

If I am understanding correctly from the checklist, the transition in Access Routine Semantic is referred to the change of the states. But I think in your MIS, some transitions are more like explanation of function. Probably that is because of the phrasing, maybe you could consider adjusting that?

SRS - Review 4

In 4.1.1 in Reliability you mentioned the program should be able to perform across various datasets, but in other part of the doc you have emphasis on working only with CIFAR-10 dataset. Which one is the case?

VnV - Clarify "Y" and "N" in Table 1

In Table 1, under the "Valid?" column, the letters "Y" and "N" are used but not defined. It's recommended to define "Y" (Yes) and "N" (No) in the "Symbols, Abbreviations, and Acronyms" section to clarify their meaning.

VnV Review_Suggestion for Section 1

For Section 1, organizing the content alphabetically could enhance readability. Additionally, given the frequent mentions of MG and MIS throughout the document, it might be beneficial to include them in Section 1 as well.

MG - Missing Modules in Traceability Matrix

In the documentation, certain modules are missing from the traceability sections. Specifically, modules M7, M9, and M10 in the table 2, and M2, M3, M8, and M9 in the table 3. Including these could provide a complete overview of module interactions and responsibilities.

VnV - Simultaneous Checking of File Type and Size

The system checks for both invalid input type and size simultaneously, which might not be efficient if the file type is already invalid. It would be better if you first check the input file type and throw an exception if it's invalid without proceeding to size verification.

VnV - Limited Data Type Handling in Input Verification Test

The Input Verification Test focuses on specific data types, but it's unclear how the system handles other, unspecified data types. It is better to throw an exception for any data type not explicitly listed as valid in the verification test to enhance error handling.

MG - Module Type Error

  1. The ANN Control Module, Input Classifier Module, Input Image Module, and Training Model Module, although defined as abstract data types, do not meet the condition to be considered ADT.

  2. The Saved ANN Model Module, although defined as Record, does not meet the condition to be it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.