compute_unit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5caf721411458c1307f2714ba330c737ddd5987433a51d7753b6004649a92429
+  data.tar.gz: ef3bacd1c4662e1ffe33dafad9c48f44c6fc3cefe161098957cc476e7ecac78d
+SHA512:
+  metadata.gz: 73b107433ce4ffcb3d6a5d35a8711cf39489ed111ccc368cb66d5f788f36690382242a3437c0bd6d40147c2ca727856d2fffd48b8b5edbaa8f4dd22b5ab228da
+  data.tar.gz: 2debc1c284e7200efd00ca0e064d3b48f55a935d55409cc77f33db2db9344efabcdaadc3cd2bfd909174e58ba38727ed4ed845dad0395a19e08dc5ee0f54a428

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+Gemfile.lock
+pci.ids
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,45 @@
+# This file is a template, and might need editing before it works on your project.
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/ruby/tags/
+image: "ruby:2.6"
+
+# Cache gems in between builds
+cache:
+  paths:
+    - vendor/ruby
+
+before_script:
+  - ruby -v  # Print out ruby version for debugging
+  - gem update bundler
+  - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+# Optional - Delete if not using `rubocop`
+rubocop:
+  allow_failure: true
+  script:
+    - bundle exec rubocop
+
+rspec2_5:
+  image: "ruby:2.5"
+  script:
+    - bundle exec rake spec
+
+rspec2_6:
+  image: "ruby:2.6"
+  script:
+    - bundle exec rake spec
+
+rspec2_7:
+  image: "ruby:2.7"
+  script:
+    - bundle exec rake spec
+
+# This deploy job uses a simple deploy flow to Heroku, other providers, e.g. AWS Elastic Beanstalk
+# are supported too: https://github.com/travis-ci/dpl
+deploy:
+  when: manual
+  type: deploy
+  environment: production
+  script:
+    - gem install dpl
+    #- dpl --provider=heroku --app=$HEROKU_APP_NAME --api-key=$HEROKU_PRODUCTION_KEY

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+inherit_from: .rubocop_todo.yml
+
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md

data/.rubocop_todo.yml

@@ -0,0 +1,139 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-12-14 19:23:33 -0800 using RuboCop version 0.77.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Layout/CommentIndentation:
+#   Exclude:
+#     - 'lib/compute_unit/device.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+# Layout/ExtraSpacing:
+#   Exclude:
+#     - 'compute_unit.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: normal, indented_internal_methods
+# Layout/IndentationConsistency:
+#   Exclude:
+#     - 'lib/compute_unit/device.rb'
+#     - 'lib/compute_unit/gpu.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/MultilineOperationIndentation:
+  Exclude:
+    - 'lib/compute_unit.rb'
+
+# Offense count: 5
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/compute_unit/compute_base.rb'
+    - 'lib/compute_unit/device.rb'
+    - 'lib/compute_unit/gpu.rb'
+
+# Offense count: 1
+Lint/UnreachableCode:
+  Exclude:
+    - 'lib/compute_unit/cpu.rb'
+
+# Offense count: 9
+Metrics/AbcSize:
+  Max: 27
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 290
+
+# Offense count: 12
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 32
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/compute_unit/gpus/amd_gpu.rb'
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db, os
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/compute_unit/device.rb'
+
+# Offense count: 8
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/compute_unit.rb'
+    - 'lib/compute_unit/asic.rb'
+    - 'lib/compute_unit/compute_base.rb'
+    - 'lib/compute_unit/cpu.rb'
+    - 'lib/compute_unit/device.rb'
+    - 'lib/compute_unit/gpu.rb'
+    - 'lib/compute_unit/gpus/amd_gpu.rb'
+    - 'lib/compute_unit/gpus/nvidia_gpu.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'compute_unit.gemspec'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, never
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+# Style/HashSyntax:
+# Exclude:
+#   - 'Rakefile'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: Strict.
+Style/NumericLiterals:
+  MinDigits: 8
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/compute_unit/gpus/amd_gpu.rb'
+
+# Offense count: 11
+# Cop supports --auto-correct.
+# Configuration parameters: .
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Offense count: 87
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 273

data/.ruby_version

@@ -0,0 +1 @@
+2.6.5

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Compute Unit Changelog
+
+## initial version 0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opselite@protonmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+
+gem 'opencl_ruby_ffi', '~> 1.3.4'
+gem 'compute_unit', path: '.'
+
+group :test do
+  gem 'pry'
+  gem 'rubocop'
+  gem 'rubocop-rspec'
+  gem 'ruby-prof'
+  gem 'simplecov'
+  gem 'rake', '~> 10.0'
+  gem 'rspec', '~> 3.0'
+  gem 'bundler', '~> 2.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Corey Osman
+
+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,74 @@
+# Compute Unit Ruby Library
+The compute unit library helps you write future abstractions and tooling for crypto mining, machine learning or just general purpose usage.  This library was extracted out of the crypto mining tool [Crossbelt](https://crossbelt.blockops.party) to help spur more tooling to ruby. 
+
+Uses the sysfs filesystem to quickly read and write compute unit data. More information about sysfs can be found [here](https://www.kernel.org/doc/Documentation/filesystems/sysfs-pci.txt)
+
+This library will:
+
+ * Detect all compute devices such as cpu, gpu, and anything else we add to this library. 
+ * Provide the ability to control GPU fans.
+ * Get temperature of units.
+ * Change or view voltage, core clock, memory clock and other tunning parameters used for overclocking.
+ * Provide inventory data of all the devices with make, model and other important information. 
+ * Provide realtime status information of various data points. Useful for real-time tunning. 
+
+This library was open sourced to allow further refinement and usage throughout the ruby community. 
+Since machine learning is not popular on ruby due to device and program support, I hope this gem will 
+make ML and crypto more viable for ruby.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'compute_unit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install compute_unit
+
+## Usage
+
+```
+require 'compute_unit'
+devices = ComputeUnit.find_all
+
+```
+
+
+## Make and Model information
+This library uses the pci database maintained here https://pci-ids.ucw.cz/ which is also used by `lspci` and other linux tools. If your device is giving the wrong info the problem is likely due to the database being incorrect. 
+
+You can also manually refresh the pci database file programmatically via `ComputeUnit.refresh_pci_database`
+
+If you want to refresh the database every time with finding all the devices you can use: `ComputeUnit.find_all_with_database`
+
+Or you can also run the simple cli tool. `update_pcidb` that comes with this library. 
+
+## Kernel support
+There will likely be changes with reading and writing information to sysfs as new kerneles are released.  This library has been tested against. 
+
+* 4.15 - 4.20
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/logicminds/compute_unit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ComputeUnit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/logicminds/compute_unit/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'compute_unit'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)