Skip to content
This repository has been archived by the owner on Aug 9, 2023. It is now read-only.
/ C-Is-For-Coding Public archive

A fun, interactive way for children to take their first step on the journey towards programming in an easy to use, natural language environment

Notifications You must be signed in to change notification settings

LV/C-Is-For-Coding

Repository files navigation

C is for Coding

As we move further into the digital age, knowing how computer programs work is becoming a more important skill for employment opportunities and understanding the world we live in. Parents are looking for and spending money on educational products that help children learn this essential skill. "C is for Coding" is a fun, interactive way for children to take their first step on this journey in an easy to use, natural language environment.

This project is in fulfillment of the CPSC 312 2021W1 project requirements.

Team Members

Our team is:

  • Philippe Solodov
  • Sam Ko
  • Scott Banducci
  • Luis Victoria

We call ourselves: Pattern Match This.

Product Pitch

Billions of dollars a year are spent on extracurricular educational programs and products by parents who want the best for their children. Competition for quality jobs is increasing and the skills necessary to succeed are becoming increasingly more technical and technological. So how can devoted parents help give their kids the best chances in this silicon-based world? They can empower them with an early, intuitive understanding of computer programming and computer science fundamentals, setting the foundation for future excellence.

"C is for Coding" is a fun, easy-to-use educational aid designed to help young children become familiar with programming. Once a child is able to type at a keyboard, they are ready to start learning on this platform. At its core, it uses natural language processing to remove the barriers of complicated syntax and unclear keywords, allowing kids to experiment and learn in a way they find natural. In this playful environment, a child can type in their best attempt at a command. Our system will interpret the intent and provide colorful graphical feedback that they can play with. "Draw cat and dog" followed by "Cat likes Dog" would generate cats and dogs, who, if separated, will move to sit near each other.

What makes "C is for Coding" unique is not just that it allows for the earliest possible introduction to this world. It also paves the road to a deeper understanding of programming languages. As children become comfortable typing in commands, they will construct more complex statements, with gentle prompts and hints to guide them, such as "Try using 'if'! :)". Eventually they will gain access to a graphical representation of code similar to what they'll see in high school, using more typical programmatic syntax. The computer equivalent of a children's book, "C is for Coding" will change what you thought possible for the ones you love most.

Minimal Viable Project

Our MVP will deliver 3 core features necessary to build the product above:

  1. Natural language processing of user input
  2. Real-time GUI
  3. Functional composition for chaining effects

In order to realistically deliver these features we will need to reduce their scope compared to the final product. We will implement only a subset of possible commands, a limited portion of our desired graphical feedback, and support for a few sequential actions.

Natural language: We will make use of Haskell's powerful abstract datatypes to interpret natural language and create a simplified pseudo-language that we can then interpret.

GUI: The gloss package will enable us to quickly develop a simple, beautiful user facing interface that will display, and potentially animate, images and text on screen.

Sequences of effects: Using the flexibility of Haskell's function composition and Typeclasses, we will allow for input interpreted as a combination of commands to correctly execute.

We are excited to learn more about natural language programming with a group member who has experience from previous courses. They will be an excellent resource getting us started. We also hope to share in learning more about using Haskell for natural language processing, with companies like Facebook using it for spam filtering. None of us have built a GUI in Haskell and we're interested to see how gloss will allow us to build one. We've all learned about functional composition in CPSC 312 but this project will give us the opportunity to implement this key feature of Haskell in a complex, real world environment.

Proof of Concept

Our POC focuses on the end-to-end pipeline:

  1. take user input (link)
  2. tokenize it using spaCy (link)
  3. parse the resulting tokens into trees (link)
  4. Parse individual elements into program commands with modifiers such as draw orange (link)
  5. Interpret the commands (link)
  6. Render the resulting world (link) to screen (link)

This represents the core event loop our product aims to provide: a user types in a command they want to see evaluated, and our product will display the effects of that command. Building this proof of concept has given us confidence that we can expand the scope of commands and refine the presentation to create an outstanding MVP. We believe that this goes above and beyond what was expected for the proof of concept, as it is a complete system which demonstrates what a solution to the problem would look like, and implements a significant portion of our proposed MVP. This project has also been built with extensibility and ease of use as a first priority, and the various components are documented and separated into distinct files, which are detailed below, and in the testing section.

Additional details of our POC:

Our proof of concept uses gloss to accept user input, and show the corresponding output. We draw user input directly into the viewing area. When the user presses enter we draw the result to the screen, which demonstrates that we can provide an interactive feedback loop in Haskell. The ease of which we accomplished this gives us confidence that we may expand the scope of the input we accept - for instance, we could allow someone to select a specific entity on screen using their mouse.

Being able to tokenize the input with the powerful natural language models provided by spaCy, using shell calls written in Haskell, makes us confident that our system will be able to handle a variety of input. Knowing this, and knowing that we can always upgrade to a more powerful English language model provided by spaCy, (or even models for other languages) makes us confident that our project will not be limited by the language models we currently use.

While we were already confident that Haskell's abstract data types and pattern matching would make parsing the tokens that spaCy produces into useful structures for our project straightforward, actually building out the functionality helped reinforce this confidence. This is currently the weakest part of our project, but it is easy to see how we could extend this to support a variety of input, without compromising on expressiveness.

How to test and run the code: Haskell

Our proof of concept provides a GUI where you can input a sentence and hit Enter to process the sentence and see what happens. To see this proof of concept in action, use make haskell-run from the project root. Note that to run the full demo, a recent version of Python (3.6+) must be installed on the system. spaCy will automatically be installed to a new virtual environment in the project directory, with the necessary language models, which should take less than 30s.

To run the tests, which test smaller portions of the project and use pretokenized data (so Python is not required, and spaCy will not be downloaded), run make haskell-eval from the project.

Using cd haskell && stack ghci (but first running make haskell-eval to set everything up), you can import the following files:

  • TLDR: using main, you can try drawing various colors of cats in the GUI by typing "draw a attribute cat" (attributes can be colors or sizes, but not all colors and sizes are supported - try "black", "red", "blue", "green", "orange", "big" and "small"). Cats currently overlap each other, so you will only see one cat of a specific size at a time.
  • Tokens.hs: This file contains the token format used throughout the project, and a Tag class which enumerates some of the parts-of-speech tags that spacy produces. You can use newTag to parse a String, or newToken to parse a String (which is the tag) and String (which is the text).
  • Tokenizer.hs: This file uses System.Process to call spaCy to tokenize text and extract part-of-speech tags, using the tokenize function, which takes a String and produces IO (Maybe [Token]). Additionally, it provides setupTokenizer, which will automatically set up a virtual environment and install spaCy if it is not found.
  • NLTree.hs - NLTree refers to natural language tree. This file contains the various datatypes used to represent a series of tokens in a tree format. You can use parse to parse the output of Tokenizer.tokenize.
  • Parse.hs - Parse.hs is an extension of NLTree.hs, which contains methods private to NLTree.hs, but separated to allow testing. Parse.hs contains additional methods for parsing adjectives and verbs into their intermediate representations. For example, parseAdjective can parse Adjective JJ "black", to an Attribute AColor black, and parseAction parses Verb VB "draw" to the action Draw. In the future, we would like to support more attributes, such as "tall", and more actions, such as "remove".
  • World.hs: This file contains both the world and entity representation. A World stores user input, as well a list of entities introduced into the world. It also provides helper methods for interacting with gloss - worldToPicture renders the world to gloss's Picture class. The apply applyAttribute function will apply an Attribute generated by parseAdjective to a target image, and is used to in individualToPicture to apply all of the attributes an individual has.
  • Main.hs: This provides the event loop used to facilitate user interaction. Calling main will set up the tokenizer and open a window with the default environment, which is empty. As the user types, they will see their text appear on screen. Once they hit Enter, the text will be interpreted. We currently support drawing a limited variety of cats, using the command "draw a attribute cat", where the attribute is optional, but can be one of black, red, blue, green, orange, small, or big (but not both).

Notes (not required to test/run code):

  • Due to OS specific dependencies, we use stack-unix.yaml and stack-win.yaml. The top level Makefile will copy the correct version to stack.yaml. This is required because stack does not allow os-specific dependencies (commercialhaskell/stack#3369).
  • We bundle freeglut.dll and glut32.dll in the src directory in order to run gloss on Windows.

Previously written

Note: We expect to be able to test your code by running stack test. Included among your tests should be some that demonstrate the core functionality of your code. (We will be running make haskell-eval from the project root.)

We should be able to further explore your code's functionality by running stack ghci, and you should instruct us on some interesting cases to try.

If you include instructions different from these, be absolutely sure that they will work well for us in whatever environment we run your code and that they will be as easy to use as the instructions above!

External Libraries Used

How to test and run the code: Prolog

Product Pitch

Intelligent tool for helping write code, which helps accelerate development by taking into considering the rest of your codebase to help you transform pseudocode into fully functional software

MVP:

Types with generics, function types, traits, and functions

  • Supports various text-search methods
  • Provides simple NLP API to return best matches for functions

POC:

  • Allow user defined functions
  • Provide simple search system (eg. line by line, ask for input, output, then docs)
  • Supports simple text-based constraints, best-first search, and input/output constraints

Replace this section with instructions to us for how to test and run your code.

Instructions coming soon, but we expect you'll use the Prolog Unit Testing library for testing and that we'll be able to run your code with swipl.

About

A fun, interactive way for children to take their first step on the journey towards programming in an easy to use, natural language environment

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published