nvidia-smi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93f2f96de404d5617142645bb68d29c262cff38e
-  data.tar.gz: 7dcc98871d3cb625dedfd420b5413e3d77a99b69
+  metadata.gz: 59d2f12427c81967e6105f1ba8ab95d89ce2dae7
+  data.tar.gz: 92bfb4cb4e5e9956a4882aa37b9b6d7e208ba67a
 SHA512:
-  metadata.gz: 73eda3ea2a7da36372a9e913f9cc67ed3f24473dafc268e751715c77ec8efa60107f7d3a0c5570fdb8aee43713e6f8524a215f65def029587444409c4e131a13
-  data.tar.gz: 259172d4d5a5d249a17bf9a45da9d0e77c82a8cdd5f6b346c45378d21b1f888c016413bde3bf34080b21b7446cae2b48612b715b72a51d04190b1a975fccf6ef
+  metadata.gz: 8965df2a060fe90da32e74e9ea80d3cb54373941744e82f4feb4702e3eb3b1bfa472648a5d152edbe5d62a416ee2fb481fc24f8897a5b42b0cf98bddbffd39ca
+  data.tar.gz: abeb56805823fb128d91cb3ebc8b8b88ac6587cbb7ce0bf007825e2f8c5d3726e6ad625b7aa1c22e6e410365a8286b50282c8bd5571c79dfe010fb32eaa19d8c

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/History.txt

@@ -1,3 +1,9 @@
+== 0.1.1 / 2017-11-06
+
+* No new features
+  * Added comments for rdoc
+  * Added specs
+
 == 0.1.0 / 2017-11-05
 
 * Very basic functionality

data/README.md

@@ -1,10 +1,16 @@
+[![Gem Version](https://badge.fury.io/rb/nvidia-smi.svg)](https://badge.fury.io/rb/nvidia-smi)
+
 nvidia-smi
 ===========
 
+Get informations about the system's GPU(s), through nvidia-smi.
+
 Features
 --------
 
-Get informations about the system's GPU(s), through nvidia-smi.
+* Get the number of GPUs seen by the driver
+* Get the driver's version
+* Get an array of Struct::Gpu objects with all relevant informations about each GPU
 
 Examples
 --------
@@ -42,7 +48,7 @@ License
 
 The MIT License
 
-Copyright (c) 2017 FIXME Julien Cornuwel
+Copyright (c) 2017 Julien Cornuwel
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -5,8 +5,8 @@ rescue LoadError
   abort '### Please install the "bones" gem ###'
 end
 
-task :default => 'test:run'
-task 'gem:release' => 'test:run'
+task :default => 'spec'
+task 'gem:release' => 'spec'
 
 Bones {
   name     'nvidia-smi'

data/lib/nvidia-smi.rb

@@ -1,5 +1,8 @@
 module NvidiaSmi
 
+  # :stopdoc:
+
+  # All the values we want to extract from nvidia-smi
   @@nvidia_keys = [
     'index',
     'pci.bus',
@@ -22,32 +25,42 @@ module NvidiaSmi
     'vbios_version'
   ]
 
+  # Attributes names in the return Struct, with _ instead of . to keep ruby happy
   return_keys = @@nvidia_keys.map(&:clone).each do |s|
     s.gsub!('.', '_')
   end
 
+  # The structure containing all the values we have about a GPU
   Struct.new('Gpu', *return_keys)
 
+  # :startdoc:
+
 
+  # Returns an Integer representing the number of GPUs seen by nvidia-smi
+  #
   def self.gpu_count
     `nvidia-smi --query-gpu=count --format=csv,noheader -i 0`.to_i
   end
 
+  # Returns a String containing the driver's version
+  #
   def self.driver_version
     `nvidia-smi --query-gpu=driver_version --format=csv,noheader -i 0`.strip
   end
 
+  # Returns an Array of Struct::Gpu
+  # The members of the struct are the values we extracted from nvidia-smi, as Strings.
+  #
   def self.gpus
     gpus = Array.new
-    data = `nvidia-smi --query-gpu=#{@@nvidia_keys.join(',')} --format=csv,noheader`.each_line do |line|
+    `nvidia-smi --query-gpu=#{@@nvidia_keys.join(',')} --format=csv,noheader`.each_line do |line|
       values = line.strip.split(',').each do |v|
         v.strip!
       end
-
       gpus << Struct::Gpu.new(*values)
     end
-    return gpus
-  end
 
+    gpus
+  end
 end
 

data/spec/nvidia-smi_spec.rb

@@ -2,5 +2,54 @@
 require File.expand_path('../spec_helper', __FILE__)
 
 describe NvidiaSmi do
+
+  context "when asked for the number of GPUs" do
+    it "should return the number of GPUs as an Integer" do
+      NvidiaSmi.should_receive(:`).with("nvidia-smi --query-gpu=count --format=csv,noheader -i 0").and_return("3")
+      expect(NvidiaSmi.gpu_count).to eq(3)
+    end
+  end
+
+  context "when asked the driver's version" do
+    it "should return the driver's version as a String" do
+      NvidiaSmi.should_receive(:`).with("nvidia-smi --query-gpu=driver_version --format=csv,noheader -i 0").and_return("384.90")
+      expect(NvidiaSmi.driver_version).to eq("384.90")
+    end
+  end
+
+  context "when asked the GPUs list" do
+
+    before(:each) do
+      NvidiaSmi.should_receive(:`).with("nvidia-smi --query-gpu=index,pci.bus,name,uuid,temperature.gpu,fan.speed,memory.used,memory.total,memory.free,utilization.memory,utilization.gpu,power.draw,power.limit,pstate,clocks.gr,clocks.sm,clocks.mem,clocks.video,vbios_version --format=csv,noheader").and_return("0, 0x01, GeForce GTX 1060 3GB, GPU-57737cf0-1db6-4905-9caa-1eeb73beb974, 71, 54 %, 2404 MiB, 3013 MiB, 609 MiB, 74 %, 99 %, 106.27 W, 120.00 W, P2, 1860 MHz, 1860 MHz, 3802 MHz, 1670 MHz, 86.06.3C.00.8E")
+    end
+
+    it "should return an Array" do
+      expect(NvidiaSmi.gpus).to be_a(Array)
+    end
+
+    it "should return an Array with one element per GPU" do
+      expect(NvidiaSmi.gpus.count).to eq(1)
+    end
+
+    it "should return an Array of Struct::Gpu" do
+      expect(NvidiaSmi.gpus.first).to be_a(Struct::Gpu)
+    end
+
+    it "should return the GPUs index" do
+      expect(NvidiaSmi.gpus.first.index).to eq("0")
+    end
+
+    it "should return the GPUs pci bus" do
+      expect(NvidiaSmi.gpus.first.pci_bus).to eq("0x01")
+    end
+
+    it "should return the GPUs model name" do
+      expect(NvidiaSmi.gpus.first.name).to eq("GeForce GTX 1060 3GB")
+    end
+
+    # Not sure there really is a point in testing every value here...
+
+  end
+
 end
 

data/version.txt

@@ -1 +1 @@
-0.1.0
+0.1.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nvidia-smi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Julien Cornuwel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bones
@@ -31,14 +31,15 @@ extensions: []
 extra_rdoc_files:
 - History.txt
 files:
+- ".Rakefile.swp"
 - ".bnsignore"
+- ".gitignore"
 - History.txt
 - README.md
 - Rakefile
 - lib/nvidia-smi.rb
 - spec/nvidia-smi_spec.rb
 - spec/spec_helper.rb
-- test/test_nvidia-smi.rb
 - version.txt
 homepage: https://github.com/cornuwel/nvidia-smi
 licenses: []
@@ -65,5 +66,4 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Get informations about the system's GPU(s), through nvidia-smi.
-test_files:
-- test/test_nvidia-smi.rb
+test_files: []