From abfaa2d9fcc10dcecb2ce8ce3a0a220d1e2ae449 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 24 Nov 2023 13:14:58 +0000 Subject: [PATCH] Update documentation from github actions --- qrbs/genindex.html | 48 ++++++++++++++++++++---------------------- qrbs/modules.html | 12 +++++------ qrbs/neasqc_qrbs.html | 44 ++++++++++++++++++++------------------ qrbs/objects.inv | Bin 2024 -> 2028 bytes qrbs/searchindex.js | 2 +- 5 files changed, 53 insertions(+), 53 deletions(-) diff --git a/qrbs/genindex.html b/qrbs/genindex.html index 47fb0a4..77a0257 100644 --- a/qrbs/genindex.html +++ b/qrbs/genindex.html @@ -92,9 +92,9 @@

Index

| M | N | O + | P | Q | R - | U | V | W @@ -248,10 +248,16 @@

B

C

@@ -287,14 +293,6 @@

F

I

-
@@ -391,6 +389,18 @@

O

+

P

+ + +
+

Q

-
  • rightHandSide (neasqc_qrbs.knowledge_rep.Rule attribute) +
  • right_hand_side (neasqc_qrbs.knowledge_rep.Rule attribute)
  • Rule (class in neasqc_qrbs.knowledge_rep)
    • @@ -441,18 +451,6 @@

    R
    -

    U

    - - -
    -

    V

      diff --git a/qrbs/modules.html b/qrbs/modules.html index 4f80254..5e86df0 100644 --- a/qrbs/modules.html +++ b/qrbs/modules.html @@ -140,9 +140,9 @@

      neasqc_qrbsFact
    • KnowledgeIsland diff --git a/qrbs/neasqc_qrbs.html b/qrbs/neasqc_qrbs.html index 339ae4d..296398c 100644 --- a/qrbs/neasqc_qrbs.html +++ b/qrbs/neasqc_qrbs.html @@ -575,7 +575,7 @@

      Submodules
      -class neasqc_qrbs.knowledge_rep.Fact(attribute, value, imprecission=0.0)
      +class neasqc_qrbs.knowledge_rep.Fact(attribute, value, precision=0.0)

      Bases: LeftHandSide

      Class representing a Fact.

      A Fact is the smallest unit of knowledge that can be represented. This class is used to model the Composite design pattern, acting as the Leaf class.

      @@ -602,9 +602,9 @@

      Submodules -
      -imprecission
      -

      Imprecission of the fact; the certainty of the attribute having said value (0 if not specified). Must be in range [0,1].

      +
      +precision
      +

      Precision of the fact; the certainty of the attribute having said value (0 if not specified). Must be in range [0,1].

      Type:

      float, optional

      @@ -619,7 +619,7 @@

      Submodules
      -property imprecission
      +property precision

      @@ -655,7 +655,7 @@

      Submodules
      -build() → qat.lang.AQASM.QRoutine
      +build(builder) → qat.lang.AQASM.QRoutine

      @@ -721,13 +721,13 @@

      Submodules
      -class neasqc_qrbs.knowledge_rep.Rule(lefthandside, righthandside, uncertainty=0.0)
      +class neasqc_qrbs.knowledge_rep.Rule(left_hand_side, right_hand_side, certainty=0.0)

      Bases: Buildable

      Class representing a Rule.

      A Rule which establishes a relationship (to some level of uncertainty) between a left hand side element and a right hand side, which in this context is a Fact.

      -
      -leftHandSide
      +
      +left_hand_side

      Left hand side element of the rule (also known as precedent).

      Type:
      @@ -737,9 +737,9 @@

      Submodules -
      -rightHandSide
      -

      Right hand side element of the rule (also known as consecuent).

      +
      +right_hand_side
      +

      Right hand side element of the rule (also known as consequent).

      Type:

      Fact

      @@ -748,9 +748,9 @@

      Submodules -
      -uncertainty
      -

      Uncertainty of the relationship between precedent and consecuent (0 if not specified). Must be in range [0,1].

      +
      +certainty
      +

      Certainty of the relationship between precedent and consequent (0 if not specified). Must be in range [0,1].

      Type:

      float, optional

      @@ -765,7 +765,7 @@

      Submodules
      -property uncertainty
      +property certainty

      @@ -775,7 +775,7 @@

      Submodules

      neasqc_qrbs.qrbs module

      -class neasqc_qrbs.qrbs.InferenceEngine(rules=[], islands=[])
      +class neasqc_qrbs.qrbs.InferenceEngine(rules=None, islands=None)

      Bases: object

      Class representing an Inference Engine.

      An Inference Engine is an element of a Rule-Based System that manages its rules and knowledge islands, providing the tools to evaluate them in order.

      @@ -882,30 +882,32 @@

      Submodules
      -static evaluate(qrbs, islands=[], model='cf') → bool
      +static evaluate(qrbs, eval_islands=None, model='cf') → bool

      Evaluates whether a QRBS can be executed on this QPU.

      Parameters:

      • qrbs (QRBS) – The QRBS to be evaluated.

      • eval_islands (List[KnowledgeIsland], optional) – A list of specific KnowledgeIsland to be evaluated.

        • +

      • model (str, optional) – The code of the model indicated.

      Raises:
      -

      ValueError – In case an specified knowledge island is not part of the QRBS or an evaluated knowledge island requires more qubits than supported.

      +

      ValueError – In case a specified knowledge island is not part of the QRBS or an evaluated knowledge island requires more qubits than supported.

      -static execute(qrbs, islands=[], model='cf') → None
      +static execute(qrbs, islands=None, model='cf') → None

      Executes the QRBS on this QPU.

      Parameters:

      • qrbs (QRBS) – The QRBS to be executed.

      • islands (List[KnowledgeIsland], optional) – A list of specific KnowledgeIsland to be executed.

        • +

      • model (str, optional) – The code of the model indicated.

      @@ -1066,7 +1068,7 @@

      Submodules
      -class neasqc_qrbs.qrbs.WorkingMemory(facts=[])
      +class neasqc_qrbs.qrbs.WorkingMemory(facts=None)

      Bases: object

      Class representing a Working Memory.

      A Working Memory is an element of a Rule-Based System that manages its facts, keeping trace of their state.

      diff --git a/qrbs/objects.inv b/qrbs/objects.inv index 3d4e036b0924327339fc99498440d2fe31215aad..18d08ad63826e09634507e313245743d1ca29b7d 100644 GIT binary patch delta 1913 zcmV-<2Zs3Q59|++h<}^Qa+^pLhWCC7sxn(hyv@$e#1+>>i7ibkla&fV+hWW`ZeSAf z^aIUBO@pA%Wf4~_{`2!S99rGxoK*PvYp{Qnhuk?;?~^PnW8u7W((~uuu}I=K?Gg76 z$Gy^zy`E*qeEE;nyHMQk36oo%~<_Ief{y*Zt$RAIb|gz6-IP7aqp)bIGx#(9~69U zQ696>r5Ph!`z-Nz$+FEZqT8)siJYDo%EtS!{lW3z^md%draLlaoNmdMcDgA~?&*#! z38)(~W#L`<`+s*u&q8Ixnl`#4Q`+d3Y-yvL@}!OK$dWd?AyeAiC#RU6HI0k6;hDIU z7iR)$hD`aVIkKgn=E;+NnjuT_X@1n)yX$TPGU=Ld@0@6~tW##><)LypNfAVOl%wgQ3|_da|T|waL7^Pn7ZL+ z&snc}RDboYM=flY{NQVbSvM&PS${k7;q`_{zD@NQCyx)`;2F_Jdbi*1KmYl0yTjeS z!De&w&;Dk6|Mw4~k7yPienGhyp7_y%=T__zi0v5|L!G zA~lX>CfMfg7U46x!!q*C^?znL95jG90*<+UQhx`IAP$0OuAiy-L&Ok=!Z6pH zWrolI;t1$-y;0Q&)D!VJ=K4t$B{%{xh^VQvB!a72O)C`=kZ;~Jia3FK8a~IQY1WKF z185`QnK7qTs_+onI2fi&qbwGvr{UA*%5e=YOip9xm?+JPUuXb!1PKfH#($D`1HmNC zEqBW^$sKUscp8^MQ>Zi>TOpW~_GfynOxs2TraRYelL*f?wn8vzTNh5EY%Od=5W3+v z;@6j1v~H~=z!I}_zB(SLr{K5spIrE@8&D6yZ(gZ3rM#+=7fU^=_P3K^8HwpJ(@+2r zL#XRT54jjY?^v)>Apwb3b${9t0nlQRX)p1ojTZnd1UZxBEYO-dY(zLZVhT)pM(m|X zUWQ_n`Q{X$9*NIUiE^P41{wev0ckh0UEaHFfjbphl50-1wjCQ0nC{%mLn1ue*b2d< zMxPJ~*YE}hAapVkC$qH{kK4S((IW39x%LYLc1 zO0lf3wW76z9&rbqR!PXobUa4F>BH5Lee@hsNsSR}~Pb#Q(MTWdvF)U243v z&{&`$@_IIc+?uC>nBBl zbg_#^Z9(*2Lkx@_zp4O2;lABxT4gOXKs3xZ_oV%HRbdM?YVyQTjSSW$P%graTw9yX zh@f=nd%3*ynn*0Tezv{4xXEGM&AfaV%F=f?Q;>QOD-{@!FmjPy?!LB{f_W*=>_Uq- zKs!aw%R|>jyh5Z2cf)_Lo<*wqtjEFqr)^8|ee>U|vn79I;PBpFN5Pau>Gu!*|o|xDgEMODz z>lY+o#A87HIM`(mUw`^qY8q+iPKBSp2K!fe$emO5KFPu|7S1~-J%8>UizI%dueg6W z?v;7%CCz@uB77EmDNb|-?@#$isTu`05|(`Nz*)&q1F#MI|IvjA$2e@24DcTCyiUDEQc- zJZ4pwW{l$Wy~M*MOC4QAwp+gvIXy5GjrU>ugX6~O=s1JTWMqmslaej$Oj4fMGZ|R| z&?IDv!n^YK?|+IOg^GqXY)nR`urVpw!p0=!2^*7mZ9-c|)4jNo+CtZV+@1VOaNoU-~oIYEMB_7>7M5pu| zaT1nkQ0G%WN{ebezg~~{(BBKGU-#*gkfI*{WBMGWumzhV@YMIq~FBcHsE5UFodJ;ur7!#8+Dbe7)jxBJh3e%$VG%h%IvZvNTd zZ14a6LF5t5w!<$dli`V9A}CQ5sHr5%CMw?E?huk|D{n9QYyw{}&5(#BlNEuXy*=Sa zqX`B2mNZF_x1plwZe@xu|4+4b1uS@n-kd_P4T zWQlN#%q@<>eJ%a8C=<6?Yxm&iB6RaAFGS+T(LwsMa>Fbr6Ok5v(VPq~jZdWguFahy zbAM`c=TVzG&Bn>SZOomWGIv^YXJCHyR_}iD=^S?#)GQmTGcf69PwlcUnh#I|Ds$B* z3dSK}e&C$^;KhFy6AE?2UZhco`e)AcdeyXEyYPBy+HN9Eh09Dc1{=La4YIVT*C)3b zWc2nDI^@Xw@)d1rr3mG_Hx3Q`!KGo1cz<%+Kv)@a&cZ63E}u>6=S0>Wer*O{ds%FS zLJDk;iVQMaCIA*I**L#*=r-t}23QZwZwokFF!{h15GM}(TX?MO^Lu;?3`!a?q{l@9 z)=02eA!#CobXE}vQO3&_qCA5MfW=Ezdq*D4iV6b8t8PygJi1#l7#y#?c{Rl&ynkT= zVDXYO$)q@wjy)8wR~;F76e}tS7@_*0s$YnDbqS3f46BhZ&5cWIpaw(_II`ZPmIrJ> zbb==d&eRVfY>2KfIDx`pTqI`~wIjP73TcDi?WW}StsU5V3BJ@6~ z8Z)9+U8rUU!)oNq_2YUtr~%Ofj(=P~DZm3;5S`%3^)p3(2pgg+47q+>X9zVQdO*+h zqq0UIo+zIq*H6kQ!4?Q7qNdQ2C|nh5TA`2v`SRwdiW7*Z$>&I#z8dCZC=whefzBI88f8q8yj}LJhDUBrL)=mU=f3nWWruw||^T?tppY zX;=qMQDxBB0>MgYU(*|P+BP7tx4f)n!*MIQP=-Re2$H4*R7ER zvBWT)FOmo1De`q8D3^TA2E;?;H}6)DO&x4gB8*i%DEha9VKoxNW2UbF0*0urcR%E+ z1ha9$3WXF%oYiS(1OSVbOn-ZuKkdH&U?Gw-Nsa=ex5Ea6Q%4MeN$ZF`6seb?DrLS$ z1&Bw==O{_J&<_JOfOtSU)@+v#FPc!GS6Ss!qL&=$gz>NQSYPbE}j->`S_ z3SjW=Ys(y~;@teV4uR%QMjl3Ot-8B1}F{l5U4J~Lay!2W$t1~Rjg5@6bntX=zRJq*+ZPm8(YI@U& vc7Tfw*5fAP7H`!KZKzn0_fQqbEFG%Mg)f8S&`^J-ZFc(lLo?F