cre_property_matcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 617f73f0d0ce70224793a55dc6ac680990d95699
+  data.tar.gz: f2a06e739e318e5b83cc6c59bf7f86cdcc3c6469
+SHA512:
+  metadata.gz: f23890b70af0eb32b9f7b857d01d0f234e44ea881722d3e3e9deb84e0235d5c20625b70bc1bfa7c089238520e93eb384463fa1d35816fca3b75baa659d60c5c8
+  data.tar.gz: 3eb950eabe40c8e9951ec2dcb9a78abd9e976ff2b16876df5f1ca5294899429c317a846c5915fe42a99d1c0bfb3390d021d3819078b1b7fee97d2adefb756654

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cre_property_matcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brad Arner
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# CrePropertyMatcher
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cre_property_matcher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cre_property_matcher
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cre_property_matcher/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/cre_property_matcher.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cre_property_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cre_property_matcher"
+  spec.version       = CrePropertyMatcher::VERSION
+  spec.authors       = ["Brad Arner"]
+  spec.email         = ["barner@chapelle.us"]
+  spec.summary       = %q{A basic implementation of the kNN Machine Learning Algorithm for Commercial Real Estate Analysis}
+  spec.description   = %q{CREPropertyMatcher facilitates the analysis of Commercial Real Estate properties by identifying the most similar properties from a set of training data.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/cre_property_matcher/property.rb

@@ -0,0 +1,140 @@
+require "date"
+require File.expand_path("../property_attributes.rb", __FILE__)
+
+class Property
+	extend PropertyAttributes
+	
+	create_property_attributes
+
+	def initialize(data)
+		@distance = 50000
+		if data.class == CSV::Row
+			load_from_csv_row(data)
+		elsif data.class == Hash
+			load_from_hash(data)
+		end
+		clean_property_types
+		clean_money_values
+		clean_percentages
+		parse_dates
+	end
+
+	def calculate_distance_from_neighbors(neighbors, features, scales)
+		neighbors.each do |neighbor|
+			values = []
+			features.each do |feature|
+				neighbor_value = neighbor.instance_variable_get(feature)
+				feature_delta = neighbor_value.nil? ?  1 : (neighbor_value - self.instance_variable_get(feature))
+				feature_delta = feature_delta / scales[feature][:range].to_f
+				value = feature_delta * feature_delta
+				values << value
+			end
+
+			unless neighbor.general_property_type == self.general_property_type
+				values << 0.005
+			end
+			
+			neighbor.distance = Math.sqrt(values.reduce(:+))
+		end
+	end
+
+	def distance
+		@distance
+	end
+
+	def distance=(value)
+		@distance = value
+	end
+
+	def show(features = [:@appraised_value, :@noi, :@ncf, :@occupancy, :@uw_revenue, :@uw_expenses, :@distance, :@general_property_type])
+		self.instance_variables.each do |i_var|
+			value = instance_variable_get(i_var)
+			puts "#{instance_variable_to_string(i_var)}: #{value}" if features.include?(i_var)
+		end	
+	end
+
+	def load_from_csv_row(data)
+		PropertyAttributes.attrs_to_sym_hash.each do |key, value|
+			data_point = data[key]
+			instance_variable_set(:"@#{value.to_s}", data_point)
+		end
+	end
+
+	def load_from_hash(data)
+		if validate_hash(data)
+			PropertyAttributes.attrs_to_sym_hash.each do |key, value|
+				data_point = data[value]
+				instance_variable_set(:"@#{value.to_s}", data_point)
+			end
+		end
+	end
+
+	def clean_property_types
+		if @general_property_type.nil?
+			return
+		elsif @general_property_type.include?("Manufactured")
+			@general_property_type = "Manufactured Housing"
+		elsif @general_property_type == "Hospitality"
+			@general_property_type = "Hotel"
+		end
+	end
+
+	def clean_money_values
+		attrs = ["noi", "ncf", "loan_amount", "appraised_value", "annual_debt_service", "uw_revenue", "uw_expenses"]
+		
+		attrs.each do |attr|
+			value = instance_variable_get(:"@#{attr}")
+			instance_variable_set(:"@#{attr}", clean_money(value))
+		end
+	end	
+
+	def clean_percentages
+		attrs = ["ltv", "interest_rate", "occupancy"]
+		
+		attrs.each do |attr|
+			value = instance_variable_get(:"@#{attr}")
+			instance_variable_set(:"@#{attr}", clean_percentage(value))
+		end
+	end
+
+	def parse_dates
+		attrs = ["loan_date", "maturity_date", "appraisal_date"]
+
+		attrs.each do |attr|
+			value = instance_variable_get(:"@#{attr}")
+			instance_variable_set(:"@#{attr}", date_parsed(value))
+		end
+	end
+
+	private
+
+	def date_parsed(value)
+		Date.strptime(value, "%m/%d/%y") if value
+	end
+
+	def clean_percentage(value)
+		return if value.nil?
+
+		new_value = value.strip.delete("%").to_f
+		if new_value > 100.0
+			# puts "Property: #{@property_name} says it has a percentage greater than 100% =>  #{new_value}"
+			new_value /= 100.0
+			# puts "New Value: #{new_value}"
+		end
+
+		new_value / 100.0
+	end
+
+	def clean_money(value)
+		value.strip.delete("$").delete(",").to_i if value
+	end
+
+	def validate_hash(hash)
+		true					
+	end
+
+	def instance_variable_to_string(instance_variable)
+		instance_variable.to_s.delete("@").split("_").map(&:capitalize).join(" ")
+	end
+end
+

data/lib/cre_property_matcher/property_attributes.rb

@@ -0,0 +1,50 @@
+module PropertyAttributes
+	def self.attrs_to_sym_hash
+		{
+			"ID" => :id,
+			"CIK Number" => :cik_number,
+			"Property Name" => :property_name,
+			"Address" => :address,
+			"City" => :city,
+			"State" => :state,
+			"Zip Code" => :zip_code,
+			"County" => :county,
+			"General Property Type" => :general_property_type,
+			"Specific Property Type" => :specific_property_type,
+			"Year Built" => :year_built,
+			"Year Renovated" => :year_renovated,
+			"Loan Amount" => :loan_amount,
+			"Interest Rate" => :interest_rate,
+			"PPP" => :ppp,
+			"Loan Date" => :loan_date,
+			"Maturity Date" => :maturity_date,
+			"Originator" => :orginator,
+			"Appraised Value" => :appraised_value,
+			"Appraisal Date" => :appraisal_date,
+			"LTV" => :ltv,
+			"DSCR" => :dscr,
+			"NOI" => :noi,
+			"NCF" => :ncf,
+			"Square Feet" => :square_feet,
+			"Title / Collateral" => :title_collateral,
+			"Ground Lease Expiration" => :ground_lease_expiration,
+			"Number of Units" => :number_of_units,
+			"Unit of Measure" => :unit_of_measure,
+			"Amortization" => :amortization,
+			"Loan Term" => :loan_term,
+			"Accrual Type" => :accrual_type,
+			"I/O" => :io,
+			"I/O Period" => :io_period,
+			"Annual Debt Service" => :annual_debt_service,
+			"Occupancy %" => :occupancy,
+			"U/W Revenue (EGI)" => :uw_revenue,
+			"U/W Expenses" => :uw_expenses
+		}
+	end
+
+	def create_property_attributes
+		PropertyAttributes.attrs_to_sym_hash.each do |key, value|
+			attr_accessor value
+		end
+	end
+end

data/lib/cre_property_matcher/property_data_loader.rb

@@ -0,0 +1,73 @@
+require "csv"
+require File.expand_path("../property.rb", __FILE__)
+
+class PropertyDataLoader
+	
+	def initialize(manner = :csv)
+		@manner = manner
+		@properties = []
+		@csv_data = nil
+	end
+
+	def self.run_and_return_properties
+		pdl = PropertyDataLoader.new
+		pdl.run_and_return_properties
+	end
+
+	def run
+		if @manner && @manner == :csv
+			load_csv if data.nil?
+			csv_to_properties
+		end
+	end
+
+	def run_and_return_properties
+		run
+		property_array
+	end
+
+	def properties
+		@properties
+	end
+
+	def property_array
+		result = []
+		properties.each do |property|
+			result << property
+		end
+		result
+	end
+
+	def add_property(property)
+		if property.class == Property
+			@properties << property
+		else
+			raise "Unable to Add Property because it is not of the Property Class"
+		end
+	end
+
+	def data
+		@csv_data
+	end
+
+	def property_data_path
+		File.expand_path("../training_data/property_data.csv", __FILE__)		
+	end
+
+	def load_csv
+		@csv_data = CSV.read(property_data_path, {headers: true})
+	end
+
+	def csv_to_properties
+		data.each do |row|
+			property = Property.new(row)
+			add_property(property)
+		end
+	end
+end
+
+# l = PropertyDataLoader.new
+# l.run
+# p l.properties
+# p l.properties.first
+

data/lib/cre_property_matcher/training_data/property_data.csv

@@ -0,0 +1 @@
+ID,CIK Number,Property Name,Address,City,State,Zip Code,County,General Property Type,Specific Property Type,Year Built,Year Renovated,Loan Amount,Interest Rate,PPP,Loan Date,Maturity Date,Originator,Appraised Value,Appraisal Date,LTV,DSCR,NOI,NCF,Square Feet,Title / Collateral,Ground Lease Expiration,Number of Units,Unit of Measure,Borrower,Guarantor,Sponsor,Amortization,Loan Term,Accrual Type,I/O,I/O Period,37,ARD Loan,39,Annual Debt Service,First Payment Date,Balance at Maturity,Lockbox,Occupancy %,Monthly Debt Service,Monthly CapEx,Monthly Tax Escrow,Monthly Insurance Escrow,Monthly TI/LC Escrow,U/W Revenue (EGI),U/W Expenses,Single Tenant,Purpose,Portfolio,Portfolio ID,Related Portfolio,Largest Tenant,Largest Tenant SqFt,Largest Tenant Lease End Date,2nd Largest Tenant,2nd Largest Tenant SqFt,2nd Largest Tenant Lease End Date,Mezz Debt,Mezz Rate,APN,3rd Largest Tenant,3rd Largest Tenant Sq.Ft.,3rd Largest Tenant Lease End Date,4th Largest Tenant,4th Largest Tenant Sq.Ft.,4th Largest Tenant Lease End Date,5th Largest Tenant,5th Largest Tenant Sq. Ft.,5th Largest Tenant Lease End Date,2009 EGI,2009 EXP,2010 EGI,2010 EXP,2011 EGI,2011 EXP,2012 EGI,2012 EXP,2013 EGI,2013 EXP,2014 EGI,2014 EXP,2015 EGI,2015 EXP,2016 EGI,2016 EXP,2017 EGI,2017 EXP,Closing Costs,T-12 Statement Date,T-12 EGI,T-12 EXP

data/lib/cre_property_matcher/version.rb

@@ -0,0 +1,3 @@
+module CrePropertyMatcher
+  VERSION = "0.0.1"
+end

data/lib/cre_property_matcher.rb

@@ -0,0 +1,95 @@
+require File.expand_path("../cre_property_matcher/version.rb", __FILE__)
+require File.expand_path("../cre_property_matcher/property_data_loader.rb", __FILE__)
+
+module CrePropertyMatcher
+	class PropertyMatcher
+		attr_accessor :reference_property, :comparison_properties
+
+		def initialize(reference_property)
+			@reference_property = Property.new(reference_property)
+			@comparison_properties = PropertyDataLoader.run_and_return_properties
+			@features = [:@appraised_value, :@noi, :@ncf, :@uw_revenue, :@uw_expenses]
+			@scales = scale_features
+		end
+
+		def reference
+			@reference_property
+		end
+
+		def comps
+			@comparison_properties
+		end
+
+		def get_suitable_comps
+			suitable = []
+			
+			comps.each do |property|
+				all_features_not_nil = true
+				features.each do |feature|
+					unless property.instance_variable_get(feature)
+						all_features_not_nil = false
+					end
+				end
+				if all_features_not_nil
+					suitable << property
+				end
+			end
+
+			suitable
+		end
+
+		def features
+			@features
+		end
+
+		def scales
+			@scales
+		end
+		
+		def head_comparison_properties(n = 6)
+			result = []
+			1.upto(n) do |index|
+				result << comps[index]
+			end
+			result
+		end
+
+		def property_type_count
+			count_hash = Hash.new(0)
+			@comparison_properties.each do |property|
+				count_hash[property.general_property_type] += 1
+			end
+			count_hash
+		end
+
+		def filter_by_feature(feature)
+			result = []
+			comps.each do |property|
+				result << property.instance_variable_get(feature)
+			end
+			result
+		end
+
+		def scale_features
+			scales = {}
+			features.each do |feature|
+				array = filter_by_feature(feature).compact
+				scales[feature] = {min: array.min, max: array.max, range: array.max - array.min}
+			end
+			scales
+		end
+
+		def calculate_distances
+			props = get_suitable_comps
+			reference.calculate_distance_from_neighbors(props, features, scales)
+		end
+		
+		def sort_comps_by_distance
+			comps.sort { |a, b| a.distance <=> b.distance }
+		end
+
+		def get_k_nearest(k = 3)
+			sort_comps_by_distance.take(k)
+		end
+	end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: cre_property_matcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brad Arner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CREPropertyMatcher facilitates the analysis of Commercial Real Estate
+  properties by identifying the most similar properties from a set of training data.
+email:
+- barner@chapelle.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cre_property_matcher.gemspec
+- lib/cre_property_matcher.rb
+- lib/cre_property_matcher/property.rb
+- lib/cre_property_matcher/property_attributes.rb
+- lib/cre_property_matcher/property_data_loader.rb
+- lib/cre_property_matcher/training_data/property_data.csv
+- lib/cre_property_matcher/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A basic implementation of the kNN Machine Learning Algorithm for Commercial
+  Real Estate Analysis
+test_files: []